List Domains

Get a list of all Domains available in the system.

List Domains

cURL

curl --request GET \
  --url https://{tenant_name}.{region}.techwolf.ai/taxonomy/domains \
  --header 'Authorization: Bearer <token>'

200

{
  "count": 2,
  "results": [
    {
      "external_id": "5cbdbdbe-5f44-4423-8157-520f8a2f429a",
      "domain_name": "IT & Engineering",
      "last_updated": "2023-05-22T13:22:39.179747"
    },
    {
      "external_id": "62d2c013-ab77-410e-b5fb-2f96eed9c1db",
      "domain_name": "Human Resources",
      "last_updated": "2023-05-22T13:22:41.165448"
    }
  ]
}

Authorizations

Authorization · string · header · required

The access token received from the authorization server in the OAuth 2.0 flow.

Query Parameters

limit · integer · default: 100

The maximal number of entities returned, ordered by the last_updated field and external_id.

Required range: 1 <= x <= 200

Example:

50

offset · integer · default: 0

The applied offset for returned entities, results starting from offset up to offset + limit.

Required range: x >= 0

include · enum<string>[]

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

count · integer · required

Total number of Domain entities stored in the system.

Required range: x >= 0

Example:

2

results · domain_content · object[] · required

Subset of Domains starting from offset up to offset + limit.

Show child attributes

Example:

[
  {
    "external_id": "5cbdbdbe-5f44-4423-8157-520f8a2f429a",
    "domain_name": "IT & Engineering",
    "last_updated": "2023-05-22T13:22:39.179747"
  },
  {
    "external_id": "62d2c013-ab77-410e-b5fb-2f96eed9c1db",
    "domain_name": "Human Resources",
    "last_updated": "2023-05-22T13:22:41.165448"
  }
]