Sign in

v1

latestOpenAPI 3.0.12026-07-243124341009.5 KB
Companies

Get Company Statuses

Returns a collection of company statuses.

get/v1/company-statuses

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 statuses.

statusIdinteger

The identifier for the status.

statusNamestring

The name for the status.

statusTypestring

The name for the type of status.

frontOfficeTenantIdinteger

The identifier for the tenant.

Example response

[
  {
    "statusId": 263,
    "statusName": "Active",
    "statusType": "General",
    "frontOfficeTenantId": 796
  }
]