Companies API

API Authentication

See API Authentication article for details.

Search Companies

Request

https://{host}/api/v1/companies?postalCode={postalCode}

postalCode: String (required) - url encoded text (e.g. 84057, USA, or T0M+123, Canada). Do not include the postal code suffix in the USA.

The number of companies is "small" there is currently no paging at this point.

Response

[
  {
    "id": 2137,
    "name": "Zerorez - Calgary",
    "marketingClientListId": "abcd1234"
   }
]

Note: Additional work will be performed to standardize error responses from the server.