Skip to main content
GET
/
dictionaries
/
{id}
Get a dictionary
curl --request GET \
  --url https://api.vocobase.com/api/v2/dictionaries/{id} \
  --header 'Authorization: Bearer <token>'
{
  "success": true,
  "data": {
    "id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
    "name": "<string>",
    "description": "<string>",
    "term_count": 123,
    "char_count": 123,
    "attached_agent_count": 123,
    "created_at": "2023-11-07T05:31:56Z",
    "updated_at": "2023-11-07T05:31:56Z",
    "terms": [
      "<string>"
    ]
  }
}

Authorizations

Authorization
string
header
required

API key in format: rg_live_xxxx. Pass as a Bearer token in the Authorization header.

Path Parameters

id
string<uuid>
required

Dictionary ID.

Response

Dictionary detail.

success
boolean
data
object