Main Product API
URL https://developers-internal.tonicdm.com
Reg Prentice apisupport@tonicdm.com
License Proprietary
Terms of Service
Main Product API
Note that the Organization/Brand the Person will belong to is determined automatically by TonicDM.
Some automated processes use this endpoint to check if a contact should be created or not. This is done by passing SelectiveNonCreation as TRUE. This will create the contact if they're a business email address only, and not create the contact if they have a system or personal email address, for example person@company.com would be created but person@gmail.com or no-reply@dropbox.com would not. This allows you to request a contact to be created without filtering the quality of the email address first. If SelectiveNonCreation is FALSEa contact will be created.
If you want to pass in the Organization information, do that as a second step using PATCH to the organizations endpoint submitting the organizationId returned in the response body. Similarly, adding an Office to the Person needs to be done using PATCH to the /persons endpoint submitting and officeId that would have been looked up using GET to the /offices endpoint submitting the organizationId returned in the response body.
Whether the item is active or inactive in TonicDM. Potentially the item could be (soft) deleted.
A phone number in 3 parts. Country code and phone number are always required.
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.
Zero or more certifications that this Person has obtained, or previously obtained. Use of this feature requires the TonicDM AdvancedContacts license.
A GUID used to link multiple EmailAddress records together, presumably 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 this feature requires the TonicDM AdvancedContacts license.
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.
curl -i -X POST \
https://developers-internal.tonicdm.com/_mock/tonicdm-product/core/emailaddresses \
-H 'Authorization: Bearer <YOUR_TOKEN_HERE>' \
-H 'Content-Type: application/json' \
-d '{
"status": "active",
"emailAddress": "user@example.com",
"name": "string",
"title": "string",
"deskPhone": {
"countryCode": 0,
"phoneNumber": 0,
"extension": 0
},
"mobilePhone": {
"countryCode": 0,
"phoneNumber": 0,
"extension": 0
},
"office": {
"status": "active",
"name": "string",
"address": "string",
"phone": {
"countryCode": 0,
"phoneNumber": 0,
"extension": 0
}
},
"disciplines": [
{
"id": "string"
}
],
"certifications": [
{
"id": "8e8aa42241794371ae9d0ed7b67a8c86",
"certificationDefinitionId": "string",
"dateExpires": "2019-08-24"
}
],
"personId": "string",
"dateActive": "2019-08-24",
"dateInactive": "2019-08-24",
"isPrime": true,
"customerDataWarehouseId": "string",
"customerErpId": "string",
"customerCrmId": "string"
}'Successfully created the resource you sent
UUID without hyphens (32 characters)
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.
A phone number in 3 parts. Country code and phone number are always required.
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.
Zero or more certifications that this Person has obtained, or previously obtained. Use of this feature requires the TonicDM AdvancedContacts license.
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.
A GUID used to link multiple EmailAddress records together, presumably 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 this feature requires the TonicDM AdvancedContacts license.
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.
{ "id": "8e8aa42241794371ae9d0ed7b67a8c86", "datetimeCreated": "2019-08-24T14:15:22Z", "datetimeUpdated": "2019-08-24T14:15:22Z", "status": "active", "emailAddress": "user@example.com", "name": "string", "title": "string", "deskPhone": { "countryCode": 0, "phoneNumber": 0, "extension": 0 }, "mobilePhone": { "countryCode": 0, "phoneNumber": 0, "extension": 0 }, "office": { "datetimeCreated": "2019-08-24T14:15:22Z", "datetimeUpdated": "2019-08-24T14:15:22Z", "status": "active", "name": "string", "address": "string", "phone": { … } }, "disciplines": [ { … } ], "certifications": [ { … } ], "emailDeliveryStatus": "unknown", "emailType": "business", "personId": "string", "dateActive": "2019-08-24", "dateInactive": "2019-08-24", "isPrime": true, "customerDataWarehouseId": "string", "customerErpId": "string", "customerCrmId": "string" }
UUID without hyphens (32 characters)
Whether the item is active or inactive in TonicDM. Potentially the item could be (soft) deleted.
A phone number in 3 parts. Country code and phone number are always required.
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.
Zero or more certifications that this Person has obtained, or previously obtained. Use of this feature requires the TonicDM AdvancedContacts license.
A GUID used to link multiple EmailAddress records together, presumably 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 this feature requires the TonicDM AdvancedContacts license.
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.
curl -i -X PATCH \
https://developers-internal.tonicdm.com/_mock/tonicdm-product/core/emailaddresses \
-H 'Authorization: Bearer <YOUR_TOKEN_HERE>' \
-H 'Content-Type: application/json' \
-d '{
"id": "8e8aa42241794371ae9d0ed7b67a8c86",
"status": "active",
"emailAddress": "user@example.com",
"name": "string",
"title": "string",
"deskPhone": {
"countryCode": 0,
"phoneNumber": 0,
"extension": 0
},
"mobilePhone": {
"countryCode": 0,
"phoneNumber": 0,
"extension": 0
},
"office": {
"status": "active",
"name": "string",
"address": "string",
"phone": {
"countryCode": 0,
"phoneNumber": 0,
"extension": 0
}
},
"disciplines": [
{
"id": "string"
}
],
"certifications": [
{
"id": "8e8aa42241794371ae9d0ed7b67a8c86",
"certificationDefinitionId": "string",
"dateExpires": "2019-08-24"
}
],
"personId": "string",
"dateActive": "2019-08-24",
"dateInactive": "2019-08-24",
"isPrime": true,
"customerDataWarehouseId": "string",
"customerErpId": "string",
"customerCrmId": "string"
}'Successfully updated the resource you requested
UUID without hyphens (32 characters)
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.
A phone number in 3 parts. Country code and phone number are always required.
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.
Zero or more certifications that this Person has obtained, or previously obtained. Use of this feature requires the TonicDM AdvancedContacts license.
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.
A GUID used to link multiple EmailAddress records together, presumably 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 this feature requires the TonicDM AdvancedContacts license.
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.
{ "id": "8e8aa42241794371ae9d0ed7b67a8c86", "datetimeCreated": "2019-08-24T14:15:22Z", "datetimeUpdated": "2019-08-24T14:15:22Z", "status": "active", "emailAddress": "user@example.com", "name": "string", "title": "string", "deskPhone": { "countryCode": 0, "phoneNumber": 0, "extension": 0 }, "mobilePhone": { "countryCode": 0, "phoneNumber": 0, "extension": 0 }, "office": { "datetimeCreated": "2019-08-24T14:15:22Z", "datetimeUpdated": "2019-08-24T14:15:22Z", "status": "active", "name": "string", "address": "string", "phone": { … } }, "disciplines": [ { … } ], "certifications": [ { … } ], "emailDeliveryStatus": "unknown", "emailType": "business", "personId": "string", "dateActive": "2019-08-24", "dateInactive": "2019-08-24", "isPrime": true, "customerDataWarehouseId": "string", "customerErpId": "string", "customerCrmId": "string" }
Gets data on one or more Persons: the User themselves, Mailboxes in their Tenant and/or Contacts in their Contact Organizations.
If called with no parameters (ie. /persons) it will return data for all Persons in no specific order.
If called with just the data_quantity=id_only parameter (ie. /persons/me with data_quantity=id_only), it will return just the personId of the user.
A specific set of persons' data can be returned by providing the filterIds parameter with an array of Person id (ie. /persons with filterIds={personId},{personId}).
If caching the Person data on the client side, the data_quantity=id_only option can be chosen to get the list of GUIDs 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.
Note that staff in the user's own Organization are Persons just like their Contacts.
A JSON-encoded string containing the query options.
Returns data for the specified GUIDs
Returns data for the specified Organization GUIDs
Provide the values of one or more statuses separated by comma (no spaces). If no value is supplied, active is assumed.
provide the GUIDs of one or more disciplines separated by comma (no spaces)
Provide the GUIDs of one or more offices separated by comma (no spaces).
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
curl -i -X GET \
'https://developers-internal.tonicdm.com/_mock/tonicdm-product/core/persons?dataQuantity=true&filterDisciplines={id}%2C{id}%2C{id}&filterIds={id}%2C{id}%2C{id}&filterOfficeIds={id}%2C{id}%2C{id}&filterOrganizationIds={OrganizationId}%2C{OrganizationId}%2C{OrganizationId}&filterStatuses=active%2Cinactive&pageNumber=1&pageSize=100&searchQuery={%22example%22}&sortBy=name&sortDirection=asc' \
-H 'Authorization: Bearer <YOUR_TOKEN_HERE>'[ { "id": "9af493dfdabb48089b068ddad94c6287", "datetimeCreated": "2021-11-03T16:21:02+00:00", "datetimeUpdated": "2024-04-20T16:21:02+00:00", "status": "active", "emailAddresses": [ … ], "name": "Rita Coolidge", "title": "Principal", "deskPhone": null, "mobilePhone": null, "office": { … }, "disciplines": null, "certifications": null, "customerDataWarehouseId": 123, "customerErpId": "a8fc7aaf-cd16-4ee4-ae97-e75808257ae1", "customerCrmId": "a9ea117f-84bc-421d-bad4-5bd69924a699" }, { "id": "496061e05a9b43a98d7cdfb0ad15e158", "datetimeCreated": "2021-11-03T16:21:02+00:01", "datetimeUpdated": "2024-04-20T16:21:02+00:01", "status": "active", "emailAddresses": [ … ], "name": "Steve Novosel", "title": "Architect", "deskPhone": null, "mobilePhone": null, "office": { … }, "disciplines": null, "certifications": null, "customerDataWarehouseId": 124, "customerErpId": "fc95ced9-8c56-4a53-89b2-1c7217ea5a9c", "customerCrmId": "fcdaf58d-5497-47a2-af3d-077c928eda27" } ]