Skip to content

Get Organizations

Returns a set of organizations.

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

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": "123 Some St. Anytown, USA 12345",
    "contact": {
      "firstName": "bob",
      "lastName": null,
      "telephoneNumber": 123-456-7890,
      "emailAddress": "bob@example.com"
    }
    "Type": "Manager"
  }
]