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/
Note that the Organization/Brand which the EmailAddress will belong to is determined automatically by TonicDM. If an appropriate Organization/Brand doesnt exist, TonicDM will auto-create them. If the UUID of a Person is given, the EmailAddress will belong to that person, Otherwise TonicDM will auto-create a Person and attach the EmailAddress to it. If required, the EmailAddress can be merged into an existing Person as a second step. Note that Person records can only be manipulated if the customer has an AdvancedContacts license.
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.
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.
Whether the item is active or inactive in TonicDM. Potentially the item could be (soft) deleted.
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 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.
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 POST \
https://developers-internal.tonicdm.com/_mock/tonicdm-product/core/emailaddresses \
-H 'Authorization: Bearer <YOUR_TOKEN_HERE>' \
-H 'Content-Type: application/json' \
-d '{
"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",
"officeId": "8e8aa42241794371ae9d0ed7b67a8c86",
"disciplines": [
"8e8aa42241794371ae9d0ed7b67a8c86"
],
"certifications": [
"8e8aa42241794371ae9d0ed7b67a8c86"
],
"selectiveNonCreation": false
}'Successfully created the resource you sent
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.
{ "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": { "id": "8e8aa42241794371ae9d0ed7b67a8c86", "datetimeCreated": "2019-08-24T14:15:22Z", "datetimeUpdated": "2019-08-24T14:15:22Z", "status": "active", "name": "string", "address": "string", "phoneCountryCode": 0, "phoneNumber": 0 }, "disciplines": [ { … } ], "certifications": [ { … } ] }
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.
Whether the item is active or inactive in TonicDM. Potentially the item could be (soft) deleted.
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 UUIDs of the Disciplines this Person is typically involved in.
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 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",
"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",
"officeId": "8e8aa42241794371ae9d0ed7b67a8c86",
"disciplines": [
"8e8aa42241794371ae9d0ed7b67a8c86"
],
"certifications": [
"8e8aa42241794371ae9d0ed7b67a8c86"
]
}'Successfully updated the resource you requested
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.
{ "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": { "id": "8e8aa42241794371ae9d0ed7b67a8c86", "datetimeCreated": "2019-08-24T14:15:22Z", "datetimeUpdated": "2019-08-24T14:15:22Z", "status": "active", "name": "string", "address": "string", "phoneCountryCode": 0, "phoneNumber": 0 }, "disciplines": [ { … } ], "certifications": [ { … } ] }
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?data_quantity=id_only), it will return just the id of the selected people.
A specific set of persons' data can be returned by providing the filterIds parameter with an array of Person id (ie. /persons?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. If this filter is specifed, all other filters will be ignored.
Returns data for the specified Organization 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/persons
https://us-api.tonicdm.com/core/persons
https://de-api.tonicdm.com/core/persons
https://ie-api.tonicdm.com/core/persons
curl -i -X GET \
'https://developers-internal.tonicdm.com/_mock/tonicdm-product/core/persons?dataQuantity=id_only&filterDisciplineIds={id}%2C{id}%2C{id}&filterIds={id}%2C{id}%2C{id}&filterOfficeIds={id}%2C{id}%2C{id}&filterOrganizationIds.%20If%20more%20than%20one%20filter%20is%20given%2C%20they%20will%20be%20combined%20with%20AND.={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" } ]