v1

latestOpenAPI 3.0.12026-07-243124341009.5 KB

Companies

Get Company Tag Definitions

Returns dropdown values for the tag definitions from the Tags tab of the company profile page.

get/v1/company-tag-definitions

Headers

RequestIdstring uuid

The unique request identifier used to correlate request data with log entries and events, formatted as a UUID.

Unique request identifier (UUID) used to correlate request data with log entries and events.

FrontOfficeTenantIdinteger

An integer identifier for the tenant that the request is being made for. Required when Tenant header is not provided.

Tenantstring

Tenant company code that determines data access scope during the request. Required when FrontOfficeTenantId header is not provided.

Response

Company category and source tag definition values.

Example response

{
  "companyCategories": [
    {
      "categoryName": "Manufacturing",
      "categoryDetails": [
        {
          "categoryID": 12345,
          "subCategory": "Software Development"
        }
      ]
    }
  ],
  "companySources": [
    {
      "id": 12345,
      "name": "Referral"
    }
  ]
}