COMPANY

Retrieves the list of ranks associated with the specified company.

GET/api/v2/companies/{companyId}/ranks

Authentication

Choose one supported method for this request.

OAuth 2.0 client credentials

Parameters

companyIdpathinteger · int32required

The unique identifier of the company for which to retrieve ranks. Must be greater than zero.

Responses

Standard response envelopeisSuccessmessageerrorsdata

Read the result from data. When isSuccess is false, errors lists what went wrong. Handling errors

An array. Each item is a CompanyRankDTO:

rolestring
rankstring
roleIDinteger · int32
rankIDinteger · int32
editableboolean

REQUEST EXAMPLE

curl --request GET \
  'https://apiv2.crmseries.com/api/v2/companies/COMPANY_ID/ranks' \
  --header 'Authorization: Bearer YOUR_ACCESS_TOKEN'

Replace the uppercase placeholders and sample values with your integration values.

RESPONSE · 200

{
  "isSuccess": true,
  "message": "",
  "data": [
    {
      "role": "string",
      "rank": "string",
      "roleID": 1024,
      "rankID": 1024,
      "editable": true,
      "availableRanks": [
        {
          "value": "string",
          "display": "string",
          "group": "string",
          "scope": "string",
          "dateRange": true
        }
      ]
    }
  ],
  "errors": []
}