Sign in

v1

latestOpenAPI 3.0.12026-07-243124341009.5 KB
Companies

Get Company Category And Details

Returns a list of company category and details. Shown in the BOLD user interface under the Tags tab for the specified company.

get/v1/company/{companyId}/company-category-tag

Path parameters

companyIdstring required

An identifier for the company whose category and details are being retrieved.

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

A list of company category and details.

Example response

[
  [
    {
      "id": 293,
      "companyId": 12345,
      "companyCategoryId": 4567,
      "companyCategoryName": "Manufacturing",
      "companyCategoryDetail": "Automotive"
    }
  ]
]