Sign in

v1

latestOpenAPI 3.0.02026-07-26155147.1 KB
ListingStatuses

List all property listing statuses

Returns a list of property listing statuses from your organization. If you have an MLS API plan, you can also get your collaborators' listing statuses for all their published properties and the properties unpublished in the last month.

get/listing_statuses

Query parameters

pageinteger

Content's page

limitinteger

Max results per page (Maximum: 100)

updated_afterstring date-time

Retrieve listing statuses for properties updated after the given time.

updated_beforestring date-time

Retrieve listing statuses for properties updated before the given time.

{
  "updated_after": "2020-03-01T23:26:53.402Z",
  "updated_before": "2020-03-01T23:26:53.402Z"
}
search[statuses][]string[]
search[include_collaborator_listings]boolean

Set this parameter to true if you have an MLS API Plan and you want to include your collaborators' listing statuses. All published properties will be included but only properties unpublished in the last month will be shown.

search[agency_id]integer

Only works if you have an MLS API plan and include_collaborator_listings is set to true. This parameter allows you to filter listings from one specific agency.

Response

Successful listing status list request.

Example response

{
  "pagination": {
    "limit": 20,
    "page": 1,
    "total": 1
  },
  "content": [
    {
      "public_id": "EB-XXX123",
      "status": "not_published",
      "updated_at": "2020-03-01T23:26:53.402Z"
    }
  ]
}