URL
Reg Prentice
License
Main Product API
https://developers-internal.tonicdm.com/_mock/tonicdm-product/
https://us-api.tonicdm.com/
https://de-api.tonicdm.com/
https://ie-api.tonicdm.com/
https://developers-internal.tonicdm.com/_mock/tonicdm-product/core/me
https://us-api.tonicdm.com/core/me
https://de-api.tonicdm.com/core/me
https://ie-api.tonicdm.com/core/me
curl -i -X GET \
https://developers-internal.tonicdm.com/_mock/tonicdm-product/core/me \
-H 'Authorization: Bearer <YOUR_TOKEN_HERE>'Successfully read the resource you requested. One or more records are returned in the form of an array.
Zero or more email addresses that person currently uses, or previously used.
This joins the User Settings to the Person record, which rolls up the email addresses.
Indicates whether the person is a TonicDM Administrator for the Tenant. This setting can only be changed by TonicDM Support. Currently the only valid values are 0 and 1, but in future this will be a bitwise field indicating different types of administrator.
Offset from UTC for the user's location. This is set automatically by the TonicDM application based on the information provided by their browser.
The division of the Organization that is assigned to the Project or Person. This allows filters/metrics by things like Market Sector or Studio.
Use of this feature requires the TonicDM AdvancedMetrics license.
The division of the Organization that is assigned to the Project or Person. This allows filters/metrics by things like Market Sector or Studio.
Use of this feature requires the TonicDM AdvancedMetrics license.
The division of the Organization that is assigned to the Project or Person. This allows filters/metrics by things like Market Sector or Studio.
Use of this feature requires the TonicDM AdvancedMetrics license.
The division of the Organization that is assigned to the Project or Person. This allows filters/metrics by things like Market Sector or Studio.
Use of this feature requires the TonicDM AdvancedMetrics license.
The date and time the user was last seen. This is when they last made an interactive call to the API.
One or more Brands (organizations) that belong to this Tenant. This is a read only field because Brands are not created or updated via this endpoint.
Zero or more Offices (physical locations) that belong to this Tenant. This is a read only field because Offices are not created or updated via this endpoint.
Allows the customer to filter projects by an extra field like Market Sector or Studio.
The name the customer wants to give to Division 1 filtering.
Allows the customer to filter projects by an extra field like Market Sector or Studio.
The name the customer wants to give to Division 2 filtering.
Allows the customer to filter projects by an extra field like Market Sector or Studio.
The name the customer wants to give to Division 3 filtering.
Allows the customer to filter projects by an extra field like Market Sector or Studio.
The name the customer wants to give to Division 4 filtering.
Whether the item is active or inactive in TonicDM. Potentially the item could be (soft) deleted.
The name given to this Office. It is used in the TonicDM app only (not put onto anything externally facing).
The address of the office. Use \n for new lines when submitting (they will be returned as <br>).
{ "id": "8e8aa42241794371ae9d0ed7b67a8c86", "emailAddresses": [ { … } ], "personId": "f3e5ff26-28ff-4cd6-9b1b-e303a185a13a", "dailyReminder": false, "isOrganizationManager": 0, "timezone": "string", "division1": { "status": "active", "name": "string" }, "division2": { "status": "active", "name": "string" }, "division3": { "status": "active", "name": "string" }, "division4": { "status": "active", "name": "string" }, "datetimeLastSeen": "2019-08-24T14:15:22Z", "datetimeCreated": "2019-08-24T14:15:22Z", "datetimeUpdated": "2019-08-24T14:15:22Z", "brands": [ { … } ], "offices": [ { … } ], "sso": { "status": "active", "urlSso": "string", "urlSlo": "string", "urlEntityId": "string", "certificateName": "string", "ssoTenantId": "string", "applicationId": "string", "applicationSecretKey": "string", "identityProvider": false }, "division1Active": false, "division1Title": "string", "division2Active": false, "division2Title": "string", "division3Active": false, "division3Title": "string", "division4Active": false, "division4Title": "string", "status": "active", "name": "string", "address": "string", "phoneCountryCode": 0, "phoneNumber": 0 }
Zero or more email addresses that person currently uses, or previously used.
The division of the Organization that is assigned to the Project or Person. This allows filters/metrics by things like Market Sector or Studio.
Use of this feature requires the TonicDM AdvancedMetrics license.
The division of the Organization that is assigned to the Project or Person. This allows filters/metrics by things like Market Sector or Studio.
Use of this feature requires the TonicDM AdvancedMetrics license.
The division of the Organization that is assigned to the Project or Person. This allows filters/metrics by things like Market Sector or Studio.
Use of this feature requires the TonicDM AdvancedMetrics license.
https://developers-internal.tonicdm.com/_mock/tonicdm-product/core/me
https://us-api.tonicdm.com/core/me
https://de-api.tonicdm.com/core/me
https://ie-api.tonicdm.com/core/me
curl -i -X PATCH \
https://developers-internal.tonicdm.com/_mock/tonicdm-product/core/me \
-H 'Authorization: Bearer <YOUR_TOKEN_HERE>' \
-H 'Content-Type: application/json' \
-d '{
"emailAddresses": [
{
"id": "8e8aa42241794371ae9d0ed7b67a8c86",
"personId": "8e8aa42241794371ae9d0ed7b67a8c86",
"status": "active",
"emailAddress": "user@example.com",
"name": "string",
"title": "string",
"deskphoneCountryCode": 0,
"deskphoneNumber": 0,
"deskphoneExtension": 0,
"mobilephoneCountryCode": 0,
"mobilephoneNumber": 0,
"dateActive": "2019-08-24",
"dateInactive": "2019-08-24",
"isPrime": true,
"customerDataWarehouseId": "string",
"customerErpId": "string",
"customerCrmId": "string"
}
],
"dailyReminder": false,
"division1": {
"status": "active",
"name": "string"
},
"division2": {
"status": "active",
"name": "string"
},
"division3": {
"status": "active",
"name": "string"
},
"division4": {
"status": "active",
"name": "string"
}
}'Successfully updated the resource you requested
Zero or more email addresses that person currently uses, or previously used.
This joins the User Settings to the Person record, which rolls up the email addresses.
Indicates whether the person is a TonicDM Administrator for the Tenant. This setting can only be changed by TonicDM Support. Currently the only valid values are 0 and 1, but in future this will be a bitwise field indicating different types of administrator.
Offset from UTC for the user's location. This is set automatically by the TonicDM application based on the information provided by their browser.
The division of the Organization that is assigned to the Project or Person. This allows filters/metrics by things like Market Sector or Studio.
Use of this feature requires the TonicDM AdvancedMetrics license.
The division of the Organization that is assigned to the Project or Person. This allows filters/metrics by things like Market Sector or Studio.
Use of this feature requires the TonicDM AdvancedMetrics license.
The division of the Organization that is assigned to the Project or Person. This allows filters/metrics by things like Market Sector or Studio.
Use of this feature requires the TonicDM AdvancedMetrics license.
The division of the Organization that is assigned to the Project or Person. This allows filters/metrics by things like Market Sector or Studio.
Use of this feature requires the TonicDM AdvancedMetrics license.
{ "emailAddresses": [ { … } ], "personId": "f3e5ff26-28ff-4cd6-9b1b-e303a185a13a", "dailyReminder": false, "isOrganizationManager": 0, "timezone": "string", "division1": { "status": "active", "name": "string" }, "division2": { "status": "active", "name": "string" }, "division3": { "status": "active", "name": "string" }, "division4": { "status": "active", "name": "string" }, "datetimeLastSeen": "2019-08-24T14:15:22Z" }
Gets data on one or more EmailAddresses.
If called with no parameters (ie. /emailaddresses) it will return data for all EmailAddresses in no specific order.
If called with just the data_quantity=id_only parameter (ie. /emailaddresses?data_quantity=id_only), it will return just the emailAddressIds of the User.
If caching the Person data on the client side, the data_quantity=id_only 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.
A JSON-encoded string containing the query options.
Returns data for the specified GUIDs. If this filter is specifed, all other filters will be ignored.
Returns data for the specified Brand GUIDs
Provide the values of one or more statuses separated by comma (no spaces). If more than one filter is given, they will be combined with AND. If no value is supplied, active is assumed.
provide the GUIDs of one or more disciplines separated by comma (no spaces). If more than one filter is given, they will be combined with AND.
Provide the GUIDs of one or more offices separated by comma (no spaces). If more than one filter is given, they will be combined with AND.
If caching data on the client side, the data_quantity=id_only|basic|complete option can be passed to manage the completeness of the data received and therefore rate limiting.
The number of results to return per page
https://developers-internal.tonicdm.com/_mock/tonicdm-product/core/emailaddresses
https://us-api.tonicdm.com/core/emailaddresses
https://de-api.tonicdm.com/core/emailaddresses
https://ie-api.tonicdm.com/core/emailaddresses
curl -i -X GET \
'https://developers-internal.tonicdm.com/_mock/tonicdm-product/core/emailaddresses?dataQuantity=id_only&filterBrandIds.%20If%20more%20than%20one%20filter%20is%20given%2C%20they%20will%20be%20combined%20with%20AND.={BrandId}%2C{BrandId}%2C{BrandId}&filterDisciplineIds={id}%2C{id}%2C{id}&filterIds={id}%2C{id}%2C{id}&filterOfficeIds={id}%2C{id}%2C{id}&filterStatuses=active%2Cinactive&pageNumber=1&pageSize=100&searchQuery={%22example%22}&sortBy=name&sortDirection=asc' \
-H 'Authorization: Bearer <YOUR_TOKEN_HERE>'Successfully read the resource you requested. One or more records are returned in the form of an array.
A UUID used to link multiple EmailAddress records together because they belong to the same physical person. There are no extra fields associated with this GUID. It serves only as a linking mechanism. Use of personId to link multiple EmailAddress records together requires the TonicDM AdvancedContacts license.
Every EmailAddress belongs to a Brand. The EmailAddress record carries the personal information and the Brand record carries the corporate information. This is set automatically by TonicDM and cannot be changed.
The date and time this email address record was last updated.
Whether the item is active or inactive in TonicDM. Potentially the item could be (soft) deleted.
The status of the last email sent to this address. This is updated by the system.
The type of email address. This is set by the system.
The date this email address became active. This is used to track the history of email addresses for a person. Use of this feature requires the TonicDM AdvancedContacts license.
The date this email address became inactive. This is used to track the history of email addresses for a person. Use of this feature requires the TonicDM AdvancedContacts license.
Indicates that this email address is the primary email address for this person. When displaying a Person, the Prime email address info will be used for their Name, etc. Use of this feature requires the TonicDM AdvancedContacts license.
The ID of the Person in the Customer's Data Warehouse. Use of this feature requires the TonicDM AdvancedMetrics license.
The ID of the Person in the Customer's ERP system (eg. Deltek Vantagepoint). Use of this feature requires the TonicDM AdvancedMetrics license.
The ID of the Person in the Customer's CRM system (eg. Deltek Salesforce). Use of this feature requires the TonicDM AdvancedMetrics license.
The physical location that is assigned to a Project or Person. This allows for filtering by Office, and the calcuation of metrics by Office. Use of this feature for Contact Organizations requires the TonicDM AdvancedContacts license.
The UUIDs of the Disciplines this Person is typically involved in.
Zero or more certifications that this Person has obtained, or previously obtained. Use of this feature requires the TonicDM AdvancedContacts license.
[ { "id": "8e8aa42241794371ae9d0ed7b67a8c86", "personId": "8e8aa42241794371ae9d0ed7b67a8c86", "brandId": "8e8aa42241794371ae9d0ed7b67a8c86", "datetimeCreated": "2019-08-24T14:15:22Z", "datetimeUpdated": "2019-08-24T14:15:22Z", "status": "active", "emailAddress": "user@example.com", "name": "string", "title": "string", "deskphoneCountryCode": 0, "deskphoneNumber": 0, "deskphoneExtension": 0, "mobilephoneCountryCode": 0, "mobilephoneNumber": 0, "emailDeliveryStatus": "unknown", "emailType": "business", "dateActive": "2019-08-24", "dateInactive": "2019-08-24", "isPrime": true, "customerDataWarehouseId": "string", "customerErpId": "string", "customerCrmId": "string", "office": { … }, "disciplines": [ … ], "certifications": [ … ] } ]