Subdomains
List Subdomains
Get a list of all Subdomains available in the system.
Authorizations
The access token received from the authorization server in the OAuth 2.0 flow.
Query Parameters
The maximal number of entities returned, ordered by the last_updated
field and external_id
.
Required range:
1 <= x <= 200
Example:
50
The applied offset for returned entities, results starting from offset
up to offset + limit
.
Required range:
x >= 0
Additional entity attributes that will be included in the response body. This query parameter can be added multiple times to include more attributes.
Available options:
custom_properties
Example:
["custom_properties"]
Response
200
application/json
OK
Total number of Subdomain Entities stored in the system.
Required range:
x >= 0
Example:
2
Subset of Subdomains starting from offset
up to offset + limit
.
Default structure for Subdomain.
Example:
[
{
"external_id": "bc3a5bc9-5f44-4423-8157-520f8a2f429a",
"subdomain_name": "Research",
"last_updated": "2023-05-22T13:22:39.179747"
},
{
"external_id": "62d2c013-ab77-410e-b5fb-2f96eed9c1db",
"subdomain_name": "Customer Work",
"last_updated": "2023-05-22T13:22:41.165448"
}
]
Was this page helpful?