Data
The following endpoints allow you to view system data used in configuring company and property settings.
Retrieves a list of available countries and their states
Either a merchant ID or a domain ID is required
Result with an array of countries and optional states
GET /api/portal/instance/company/countries HTTP/1.1
Host: partners.clym.io
Authorization: Bearer YOUR_SECRET_TOKEN
Accept: */*
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"
}
]
}
]
}
Retrieves a list of available system sectors
Either a merchant ID or a domain ID is required
Result with an array of sectors
GET /api/portal/instance/company/sectors HTTP/1.1
Host: partners.clym.io
Authorization: Bearer YOUR_SECRET_TOKEN
Accept: */*
Result with an array of sectors
{
"meta": {
"current_page": 1,
"next_page": 1,
"prev_page": 1
},
"result": [
{
"id": 1,
"name": "text",
"description": "text"
}
]
}
Retrieves a list of available system industries
Either a merchant ID or a domain ID is required
Result with an array of industries
GET /api/portal/instance/company/industries HTTP/1.1
Host: partners.clym.io
Authorization: Bearer YOUR_SECRET_TOKEN
Accept: */*
Result with an array of industries
{
"meta": {
"current_page": 1,
"next_page": 1,
"prev_page": 1
},
"result": [
{
"id": 1,
"name": "text",
"description": "text"
}
]
}
Retrieves a list of available system criteria groups
Either a merchant ID or a domain ID is required
Result with an array of criterias
GET /api/portal/instance/company/criteria-groups HTTP/1.1
Host: partners.clym.io
Authorization: Bearer YOUR_SECRET_TOKEN
Accept: */*
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"
}
]
}
]
}
Last updated