Catylist API Reference

RESTful, Read-Only, with JSON Output

Request an API Key

Terms of Use

By using the Catylist API, you agree to be bound by our Catylist API Terms of Use.

Making a request

The Catylist API is organized around REST. Our API has predictable, resource-oriented URLs, and uses HTTP response codes to indicate errors. All URLs start with https://[API Key]:@api.catylist.com/v2/ where v2 is the API version number. All requests must be made over HTTPS.

Each request must also include an API key for authentication. Authentication is done using standard HTTP Basic authentication where the username is your API key (the password is ignored).

Payload

JSON is returned by all API responses, including errors. Single item results won't have any envelop but endpoints which return a set of results will be wrapped like so:

{
   "total": 123,
   "results": [ ... ],
   "from": 0,
   "size": 10
}

Each set of results supports paging, so you may need to make several calls to traverse the entire set. To specify which page of data to fetch, add the "from" and "size" query string parameters to your request.

The API strives to be self-documenting. Finding a list of available fields is best accomplished by pulling down a well populated object and inspecting the data.

API endpoints

Listings

List the first dozen listings

GET /v2/listings?from=0&size=12

List the first hundred listings modified since a given date

GET /v2/listings?from=0&size=100&modifiedSince=2019-01-01

Get a single listing

GET /v2/listings/55_29729168

Professionals/Agents

List all professionals

GET /v2/professionals?from=0&size=10

Get a single professional

GET /v2/professionals/10820002

Companies

List all companies

GET /v2/companies?from=0&size=10

Get a single company

GET /v2/companies/2531

Get a list of professionals who are associated with the company

GET /v2/companies/2531/professionals

Help us make it better

Tell us how we can make the API more useful. If you have a specific feature request or if you've found a bug, let us know!