March 18, 2024

TenantSettings

JSONCopyCopied!

GET TenantSettings

Endpoint:

When used with

method, this end point will return a collection of valid options for Work Types (used with endpoints), Contact Types (used with and endpoints) and Work Statuses (used when setting or updating the and properties of )

Refer to the TenantSettings API documentation for a full example of the response from this endpoint.

Example use case

You want to integrate a CRM system with Karbon, creating contact records in Karbon when you sign a new client and adding onboarding work.

You need:

• a list of valid Contact Types so that your API integration can perform a mapping of types from your CRM system to the
  JSONCopyCopied!

  ContactTypes
  used in Karbon
• a list of valid Work Types so that your API integration can assign the correct WorkType to the onboarding
  JSONCopyCopied!

  WorkItems

Making a call to

will return a JSON response with a collection of and a collection of , e.g.

JSONCopyCopied!
{
  "ContactTypes": [
    {
      "name": "Client",
      "ContactTypeKey": "3Qk8VS4LHyMb"
    },
    ...
  ],
  "WorkTypes": [
    {
      "Name": "Accounting",
      "WorkTypeKey": "nTlQkTQnNz7",
      "AvailableStatuses": {
        ...
      }
    },
    ...
  ]
}

---

Notes:

Values for Primary Work Statuses are controlled across all Karbon accounts - only Secondary status types can be edited.

Within Karbon, admin users can specify which Secondary statuses apply to which Work Types - meaning some statuses may not be valid for use with specific Work Types. The

collection in the API response includes an applicable Primary status names and Secondary status keys. This allows API consumers to perform validation of a combination of Primary and Secondary statuses for a specific Work Type.

Because the names for items in the

and collections are editable they are provided along with a unique Key. This key will remain unchanged even if the name is changed.