Skip to content

Brands & Locations

Data on Organizations (includes both staff and contacts, so these do not need to be looked up separately and combined).

Operations

Get Organizations

Request

Organizations is a feature of the AdvancedContacts TonicDM license. Without that licence, the API user should work one level down with Brands.

If called with no parameters (ie. /organizations) it will return paged data for the Brands and Locations in the User's Tenant and all Contact Organizations, in no specific order.

A specific set of organizations' data can be returned by providing the filterIds parameter with an array of Organization id (ie. /organizations with filterIds={organizationId},{organizationId}). If caching the organization data on the client side, the dataQuantity=idOnly option can be chosen to get the list of UUIDs that match the filtering/sorting/paging requirements with the organization data coming from your client side cache, having been retrieved by providing the filterIds parameter with an array of id.

You can also get the list of Locations (offices) or Brands for an Organization by calling /locations with filterOrganizationIds={organizationId} or /brands with filterOrganizationIds={organizationId}. Locations and Brands for Organizations other than your own are a feature of the AdvancedContacts TonicDM license.

Security
OAuth2(Required scopes: read)
Bodyapplication/json
filterIdsArray of strings

Returns data for the specified UUIDs. If this filter is specifed, all other filters will be ignored.

dataQuantitystring

If caching data on the client side, the dataQuantity=idOnly|basic|complete option can be passed to manage the completeness of the data received and therefore rate limiting.

Default:"idOnly"
Enum:"idOnly""basic""complete"
pageSizeinteger, [ 1 .. 1000 ]

The number of results to return per page

Default:50
pageNumberinteger

Which page of the results to return

curl -i -X POST \
  https://developers-internal.tonicdm.com/_mock/tonicdm-product/core/organizations/select \
  -H 'Authorization: Bearer <YOUR_TOKEN_HERE>' \
  -H 'Content-Type: application/json' \
  -d '{
    "filterIds": [
      "8e8aa42241794371ae9d0ed7b67a8c86"
    ],
    "dataQuantity": "idOnly",
    "pageSize": 50,
    "pageNumber": 0
  }'

Responses

Successfully read the resource you requested. One or more records are returned in the form of an array.

Bodyapplication/json
statusstringrequired
Value:"success"
dataArray of objects(Organization)required
metadataobject(ResponseMetadata)required

Present on every JSON response. For non-paginated operations, page will be 1, total_pages will be 1, and total_records equal to the number of elements in data.

Response
[
  {
    "id": "810e48a87ec44cf0bfbf43c6d0af2ee6",
    "datetimeCreated": "2021-11-03T16:21:02+00:00",
    "datetimeUpdated": "2024-04-20T16:21:02+00:00",
    "brands": [ … ]
  },
  {
    "id": "f5fcae6d03f342ceb9eb8c9b9250c0ce",
    "datetimeCreated": "2021-11-03T16:21:02+00:00",
    "datetimeUpdated": "2024-04-20T16:21:02+00:00",
    "brands": [ … ]
  }
]