Skip to content

EmailAddresses

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

Operations

Get EmailAddresses

Request

emailAddress is the object that stores contact records in TonicDM.

If caching the Person 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 Person data coming from your client side cache, having been retrieved by providing the filterIds parameter with an array of id.

Security
OAuth2(Required scopes: read)
Bodyapplication/json
searchQuerystring, (JSON)

A JSON-encoded string containing the query options.

filterIdsArray of strings

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

filterBrandIdsArray of strings

Returns data for the specified Brand UUIDs

filterStatusesArray of strings

Provide the values in an array. If more than one value is given, they will be combined with OR. If no value is supplied, active is assumed.

filterDisciplineIdsArray of strings

provide the UUIDs of one or more disciplines separated by comma (no spaces). If more than one filter is given, they will be combined with AND.

filterLocationIdsArray of strings

Provide the UUIDs of one or more locations separated by comma (no spaces). If more than one filter is given, they will be combined with AND.

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

sortByEmailAddressesstring

The field by which to sort the results

Enum:"name""email""title""location"
sortDirectionstring

The sort direction for the results

Enum:"asc""desc"
curl -i -X POST \
  https://developers-internal.tonicdm.com/_mock/tonicdm-product/core/emailaddresses/select \
  -H 'Authorization: Bearer <YOUR_TOKEN_HERE>' \
  -H 'Content-Type: application/json' \
  -d '{
    "searchQuery": "string",
    "filterIds": [
      "8e8aa42241794371ae9d0ed7b67a8c86"
    ],
    "filterBrandIds": [
      "8e8aa42241794371ae9d0ed7b67a8c86"
    ],
    "filterStatuses": [
      "active"
    ],
    "filterDisciplineIds": [
      "8e8aa42241794371ae9d0ed7b67a8c86"
    ],
    "filterLocationIds": [
      "8e8aa42241794371ae9d0ed7b67a8c86"
    ],
    "dataQuantity": "idOnly",
    "pageSize": 50,
    "pageNumber": 0,
    "sortByEmailAddresses": "name",
    "sortDirection": "asc"
  }'

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(EmailAddress)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
{
  "status": "success",
  "data": [
    { … }
  ],
  "metadata": {
    "timestamp": "2019-08-24T14:15:22Z",
    "correlation_id": "string",
    "page": 1,
    "total_pages": 1,
    "total_records": 0
  }
}