Get agencies

Returns all agencies for the account, potentially modified by query params.

Request

GET /agency

Response

{
  "messages": [],
  "entity": {
    id: <integer>,
    name: <string>,
    contact_name: <string>,
    street: <string>,
    city: <string>,
    state: <string>,
    zip: <string>,
    country: <string>,
    phone: <string>,
    fax: <string>,
    email: <string>,
    description: <string>,
    externalAgencyId: <string>
  }
}

Get Agency by External ID

Request

GET /agency?externalAgencyId=123#Test

Note that the request string must be URL encoded in case it contains any characters requiring encoding. 

Response

{
  "messages": [],
  "entity": [
    {
      "name": "My new agency",
      "contact_name": "John Smith",
      "street": "123 Any St",
      "city": "New York",
      "state": "NY",
      "zip": "10018",
      "country": "USA",
      "phone": "555-555-5555",
      "fax": "444-444-4444",
      "email": "[email protected]",
      "description": "This is my new agency",
      "externalAgencyId": "123#Test"
    }
  ]
}
Language
Credentials
Basic
base64
:
URL
Click Try It! to start a request and see the response here!