GetActiveListings

This request returns a list of all packages.

Request URL

GET https://api.theownly.io/v1/listings

Headers

Name	Value	Required?
Accept	application/json	Yes
Authorization	Bearer{APItoken}	Yes

Parameters

Name	Type	Required?	Description
communityId	String	No	Filter by community ID
modelId	String	No	Filter by model ID
externalId	String	No	Filter by External ID
page	number	No	page number
pageSize	number	No	Page Size to limit the number of items

Example Request

curl -X 'GET' \
  'https://api.theownly.io/v1/listings' \
  -H 'accept: application/json' \
  -H 'Authorization: Bearer {APItoken}' \

Example Response

  {
  "data": [
    {
      "id": "q65lxb59",
      "externalId": "string",
      "address": "string",
      "availability": "available",
      "status": "draft",
      "url": "string",
      "description": "string",
      "price": 0,
      "beds": 0,
      "baths": 0,
      "sizeSqft": 0,
      "community": {
        "id": "uFMhi7hj",
        "name": "string",
        "subRegion": "string",
        "address": "string",
        "description": "string",
        "websiteUrl": "string",
        "city": {
          "id": "Eynvv3nd",
          "name": "Calgary",
          "state": "Alberta"
        }
      },
      "model": {
        "id": "TbuHj789",
        "name": "string",
        "intro": "string",
        "beds": 0,
        "baths": 0,
        "sizeSqft": 0,
        "basePrice": 0,
        "tourUrl": "string",
        "uTourUrl": "string",
        "productType": {
          "id": "Oo5BqeAm",
          "name": "string"
        }
      },
      "reservationUrl": "string"
    }
  ],
  "pagination": {
    "results": 100,
    "page": 1,
    "pageSize": 25,
    "pages": 4
  }
}