Skip to content

Get Organizations

Returns a set of organizations.

Verb POST
Endpoint {base-url}/organizations
Max Page Size 1000

Request Body

{
  // optional list of IDs for the organizations you want to retrieve
  "requestFilter": {
    "organizationIds": []
  }
}

Filters Honored

Returns

On Success

The requested set of organizations.

Response Body

[
  {
    "id": 1,
    "administrativeOrganizationId": 3,
    "name": "Generic Vending",
    "address": {
      "addressLineOne": "123 Some St.",
      "addressLineTwo": null,
      "city": "Anytown",
      "state": "NY",
      "zip": "12345"
    },
    "type": "operator",
    "contact": {
      "firstName": "bob",
      "lastName": null,
      "telephoneNumber": "123-456-7890",
      "emailAddress": "bob@example.com"
    }
  }
]