Main Product API
URL https://developers-internal.tonicdm.com
Reg Prentice apisupport@tonicdm.com
License Proprietary
Terms of Service
Main Product API
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.
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/projects?dataQuantity=true&filterIds={id}%2C{id}%2C{id}&filterOrganizationIds={OrganizationId}%2C{OrganizationId}%2C{OrganizationId}&filterStatuses=active%2Cinactive&pageNumber=1&pageSize=100&searchQuery={%22example%22}&sortBy=projectNumber&sortDirection=asc' \
-H 'Authorization: Bearer <YOUR_TOKEN_HERE>'A paged array of projects
Puts the project into a status of readOnly (data can be read but not written) or noAccess (data cannot be read or written). These states can only be set by the system and are used when project data is being migrated between Zones (data centers) or for other administrative purposes.
Whether the item is active or inactive in TonicDM. Potentially the item could be (soft) deleted.
Projects are used for different purposes in the TonicDM system.
Restricts access to the project to active team members. This field can only be set by one of the Tenant Adminstrators.
The full official name of the Project (used on Transmittals).
A friendly name for the Project (used in the TonicDM app)
Text to assist staff when searching for the project (typically previously used project numbers or names)
Data for one Brand of an Organization. All TonicDM Organizations have one or more Brands.
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 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.
Zero or more certifications that this Person has obtained, or previously obtained. Use of this feature requires the TonicDM AdvancedContacts license.
Whether the RFIs should default to the senders number or use a unique sequential number. This is done as an enum in case there are other options added in the future, such as pattern.
The default number of days we have to return RFIs back to the organization we received them from
The default number of days we have to return Submittals back to the organization we received them from
The default number of days our consultants have to return Submittals back us.
The OrganizationId of the project's client (so their name can appear on the Transmittal).
[ { "id": "f71f272f752c4307b36c5124688562c4", "datetimeCreated": "2021-11-03T16:21:02+00:00", "datetimeUpdated": "2024-04-20T16:21:02+00:00", "status": "active", "zone": "aws-us", "isLocked": true, "projectNumber": "20-032", "projectNameLong": "Olympic Rugby Venue", "projectNameShort": "Paris Stadium", "projectManager": "1edb8a0bb607442ba167b9d28a75778c", "projectPrincipal": null, "brandId": null, "officeId": { … }, "division1Id": null, "division2Id": null, "certifications": null, "settingsCa": null, "clientOrganizationsId": null, "clientProjectNumber": "65702P", "customerDataWarehouseId": 675, "customerErpId": "8b37e6b2-786e-4546-93e8-d6760e71bed4", "customerCrmId": "8a12f0af-249d-435b-b997-2034fd472ff8" }, { "id": "d6935bb577244d1692fe544c9c8ae6bd", "datetimeCreated": "2021-11-03T16:21:02+00:01", "datetimeUpdated": "2024-04-20T16:21:02+00:01", "status": "inactive", "zone": "aws-us", "isLocked": false, "projectNumber": "17-005", "projectNameLong": "Es Todo Cafe and Grill", "projectNameShort": "Es Todo", "officeId": { … }, "division1Id": null, "certifications": null, "customerDataWarehouseId": 987, "customerErpId": "ae656d88-c979-4e11-ba0b-695b61fa7f5d", "customerCrmId": "9a6d37ef-fc9d-43ee-ac78-678c273cc1e8" } ]
Puts the project into a status of readOnly (data can be read but not written) or noAccess (data cannot be read or written). These states can only be set by the system and are used when project data is being migrated between Zones (data centers) or for other administrative purposes.
Whether the item is active or inactive in TonicDM. Potentially the item could be (soft) deleted.
Projects are used for different purposes in the TonicDM system.
Restricts access to the project to active team members. This field can only be set by one of the Tenant Adminstrators.
The full official name of the Project (used on Transmittals).
A friendly name for the Project (used in the TonicDM app)
Text to assist staff when searching for the project (typically previously used project numbers or names)
Data for one Brand of an Organization. All TonicDM Organizations have one or more Brands.
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 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.
Zero or more certifications that this Person has obtained, or previously obtained. Use of this feature requires the TonicDM AdvancedContacts license.
Whether the RFIs should default to the senders number or use a unique sequential number. This is done as an enum in case there are other options added in the future, such as pattern.
The default number of days we have to return RFIs back to the organization we received them from
The default number of days we have to return Submittals back to the organization we received them from
The default number of days our consultants have to return Submittals back us.
The OrganizationId of the project's client (so their name can appear on the Transmittal).
curl -i -X POST \
https://developers-internal.tonicdm.com/_mock/tonicdm-product/core/projects \
-H 'Authorization: Bearer <YOUR_TOKEN_HERE>' \
-H 'Content-Type: application/json' \
-d '{
"status": "active",
"zone": "aws-us",
"isLocked": true,
"projectNumber": "20-032",
"projectNameLong": "Olympic Rugby Venue",
"projectNameShort": "Paris Stadium",
"officeIdId": "b215b20dab3b4632a061f48315fc04e8",
"division1Id": null,
"certifications": null,
"customerDataWarehouseId": 675,
"customerErpId": "8b37e6b2-786e-4546-93e8-d6760e71bed4",
"customerCrmId": "8a12f0af-249d-435b-b997-2034fd472ff8"
}'Successfully created the resource you sent
Puts the project into a status of readOnly (data can be read but not written) or noAccess (data cannot be read or written). These states can only be set by the system and are used when project data is being migrated between Zones (data centers) or for other administrative purposes.
Whether the item is active or inactive in TonicDM. Potentially the item could be (soft) deleted.
Projects are used for different purposes in the TonicDM system.
Restricts access to the project to active team members. This field can only be set by one of the Tenant Adminstrators.
The full official name of the Project (used on Transmittals).
A friendly name for the Project (used in the TonicDM app)
Text to assist staff when searching for the project (typically previously used project numbers or names)
Data for one Brand of an Organization. All TonicDM Organizations have one or more Brands.
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 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.
Zero or more certifications that this Person has obtained, or previously obtained. Use of this feature requires the TonicDM AdvancedContacts license.
Whether the RFIs should default to the senders number or use a unique sequential number. This is done as an enum in case there are other options added in the future, such as pattern.
The default number of days we have to return RFIs back to the organization we received them from
The default number of days we have to return Submittals back to the organization we received them from
The default number of days our consultants have to return Submittals back us.
The OrganizationId of the project's client (so their name can appear on the Transmittal).
{ "id": "f71f272f752c4307b36c5124688562c4", "datetimeCreated": "2021-11-03T16:21:02+00:00", "datetimeUpdated": "2024-04-20T16:21:02+00:00", "status": "active", "zone": "aws-us", "isLocked": true, "projectNumber": "20-032", "projectNameLong": "Olympic Rugby Venue", "projectNameShort": "Paris Stadium", "projectManager": "1edb8a0bb607442ba167b9d28a75778c", "projectPrincipal": null, "brandId": null, "officeId": { "id": "b215b20dab3b4632a061f48315fc04e8", "datetimeCreated": "2021-11-03T16:21:02+00:00", "datetimeUpdated": "2024-04-20T16:21:02+00:00", "status": "active", "name": "Cambridge", "address": "233 Kirkland Street\\nCambridge", "phone": { … } }, "division1Id": null, "division2Id": null, "certifications": null, "settingsCa": null, "clientOrganizationsId": null, "clientProjectNumber": "65702P", "customerDataWarehouseId": 675, "customerErpId": "8b37e6b2-786e-4546-93e8-d6760e71bed4", "customerCrmId": "8a12f0af-249d-435b-b997-2034fd472ff8" }
Puts the project into a status of readOnly (data can be read but not written) or noAccess (data cannot be read or written). These states can only be set by the system and are used when project data is being migrated between Zones (data centers) or for other administrative purposes.
Whether the item is active or inactive in TonicDM. Potentially the item could be (soft) deleted.
Projects are used for different purposes in the TonicDM system.
Restricts access to the project to active team members. This field can only be set by one of the Tenant Adminstrators.
The full official name of the Project (used on Transmittals).
A friendly name for the Project (used in the TonicDM app)
Text to assist staff when searching for the project (typically previously used project numbers or names)
Data for one Brand of an Organization. All TonicDM Organizations have one or more Brands.
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 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.
Zero or more certifications that this Person has obtained, or previously obtained. Use of this feature requires the TonicDM AdvancedContacts license.
Whether the RFIs should default to the senders number or use a unique sequential number. This is done as an enum in case there are other options added in the future, such as pattern.
The default number of days we have to return RFIs back to the organization we received them from
The default number of days we have to return Submittals back to the organization we received them from
The default number of days our consultants have to return Submittals back us.
The OrganizationId of the project's client (so their name can appear on the Transmittal).
curl -i -X PATCH \
https://developers-internal.tonicdm.com/_mock/tonicdm-product/core/projects \
-H 'Authorization: Bearer <YOUR_TOKEN_HERE>' \
-H 'Content-Type: application/json' \
-d '{
"id": "d6935bb577244d1692fe544c9c8ae6bd",
"status": "inactive",
"zone": "aws-us",
"isLocked": false,
"projectNumber": "17-005",
"projectNameLong": "Es Todo Cafe and Grill",
"projectNameShort": "Es Todo",
"officeIdId": "570e423760dc4c9784d20a38216f0597",
"division1Id": null,
"certifications": null,
"customerDataWarehouseId": 987,
"customerErpId": "ae656d88-c979-4e11-ba0b-695b61fa7f5d",
"customerCrmId": "9a6d37ef-fc9d-43ee-ac78-678c273cc1e8"
}'Successfully updated the resource you requested
Puts the project into a status of readOnly (data can be read but not written) or noAccess (data cannot be read or written). These states can only be set by the system and are used when project data is being migrated between Zones (data centers) or for other administrative purposes.
Whether the item is active or inactive in TonicDM. Potentially the item could be (soft) deleted.
Projects are used for different purposes in the TonicDM system.
Restricts access to the project to active team members. This field can only be set by one of the Tenant Adminstrators.
The full official name of the Project (used on Transmittals).
A friendly name for the Project (used in the TonicDM app)
Text to assist staff when searching for the project (typically previously used project numbers or names)
Data for one Brand of an Organization. All TonicDM Organizations have one or more Brands.
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 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.
Zero or more certifications that this Person has obtained, or previously obtained. Use of this feature requires the TonicDM AdvancedContacts license.
Whether the RFIs should default to the senders number or use a unique sequential number. This is done as an enum in case there are other options added in the future, such as pattern.
The default number of days we have to return RFIs back to the organization we received them from
The default number of days we have to return Submittals back to the organization we received them from
The default number of days our consultants have to return Submittals back us.
The OrganizationId of the project's client (so their name can appear on the Transmittal).
{ "id": "d6935bb577244d1692fe544c9c8ae6bd", "datetimeCreated": "2021-11-03T16:21:02+00:01", "datetimeUpdated": "2024-04-20T16:21:02+00:01", "status": "inactive", "zone": "aws-us", "isLocked": false, "projectNumber": "17-005", "projectNameLong": "Es Todo Cafe and Grill", "projectNameShort": "Es Todo", "officeId": { "id": "570e423760dc4c9784d20a38216f0597", "datetimeCreated": "2021-11-03T16:21:02+00:01", "datetimeUpdated": "2024-04-20T16:21:02+00:01", "status": "active", "name": "London", "address": "123 Dundas Street\\nLondon", "phone": { … } }, "division1Id": null, "certifications": null, "customerDataWarehouseId": 987, "customerErpId": "ae656d88-c979-4e11-ba0b-695b61fa7f5d", "customerCrmId": "9a6d37ef-fc9d-43ee-ac78-678c273cc1e8" }