Data

The following endpoints allow you to view system data used in configuring company and property settings.

Get countries

get

Retrieves a list of available countries and their states

Authorizations

bearerAuth

AuthorizationstringRequired

API key generated in Clym Partner Portal.

Query parameters

merchant_idstringOptional

Either a merchant ID or a domain ID is required

domain_idstringOptional

Responses

200

Result with an array of countries and optional states

application/json

get

/portal/instance/company/countries

HTTPcURLJavaScriptPython

GET /api/portal/instance/company/countries HTTP/1.1
Host: partners.clym.io
Authorization: Bearer YOUR_SECRET_TOKEN
Accept: */*

200

Result with an array of countries and optional states

{
  "meta": {
    "current_page": 1,
    "next_page": 1,
    "prev_page": 1
  },
  "result": [
    {
      "id": "US",
      "name": "United States",
      "continent_id": "NA",
      "states": [
        {
          "id": "AL",
          "name": "Alabama"
        }
      ]
    }
  ]
}

Get sectors

get

Retrieves a list of available system sectors

Authorizations

bearerAuth

AuthorizationstringRequired

API key generated in Clym Partner Portal.

Query parameters

merchant_idstringOptional

Either a merchant ID or a domain ID is required

domain_idstringOptional

Responses

200

Result with an array of sectors

application/json

get

/portal/instance/company/sectors

HTTPcURLJavaScriptPython

GET /api/portal/instance/company/sectors HTTP/1.1
Host: partners.clym.io
Authorization: Bearer YOUR_SECRET_TOKEN
Accept: */*

200

Result with an array of sectors

{
  "meta": {
    "current_page": 1,
    "next_page": 1,
    "prev_page": 1
  },
  "result": [
    {
      "id": 1,
      "name": "text",
      "description": "text"
    }
  ]
}

Get industries

get

Retrieves a list of available system industries

Authorizations

bearerAuth

AuthorizationstringRequired

API key generated in Clym Partner Portal.

Query parameters

merchant_idstringOptional

Either a merchant ID or a domain ID is required

domain_idstringOptional

Responses

200

Result with an array of industries

application/json

get

/portal/instance/company/industries

HTTPcURLJavaScriptPython

GET /api/portal/instance/company/industries HTTP/1.1
Host: partners.clym.io
Authorization: Bearer YOUR_SECRET_TOKEN
Accept: */*

200

Result with an array of industries

{
  "meta": {
    "current_page": 1,
    "next_page": 1,
    "prev_page": 1
  },
  "result": [
    {
      "id": 1,
      "name": "text",
      "description": "text"
    }
  ]
}

Get criteria groups

get

Retrieves a list of available system criteria groups

Authorizations

bearerAuth

AuthorizationstringRequired

API key generated in Clym Partner Portal.

Query parameters

merchant_idstringOptional

Either a merchant ID or a domain ID is required

domain_idstringOptional

Responses

200

Result with an array of criterias

application/json

get

/portal/instance/company/criteria-groups

HTTPcURLJavaScriptPython

GET /api/portal/instance/company/criteria-groups HTTP/1.1
Host: partners.clym.io
Authorization: Bearer YOUR_SECRET_TOKEN
Accept: */*

200

Result with an array of criterias

{
  "meta": {
    "current_page": 1,
    "next_page": 1,
    "prev_page": 1
  },
  "result": [
    {
      "id": 1,
      "name": "text",
      "description": "text",
      "applied_to": "USER",
      "criterias": [
        {
          "id": 1,
          "name": "text",
          "value": "text"
        }
      ]
    }
  ]
}