Verify Key

Test that your API key is valid and see which organisation it is scoped to.

Endpoint

GET /v1/

Authentication: Bearer API key

Request

No body or query parameters required.

Response

200 OK

{
  "api": "TalkNTalk",
  "version": "v1",
  "organisation": {
    "id": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
    "name": "Acme Corp",
    "slug": "acme-corp"
  }
}

Field	Type	Description
`api`	string	Always `"TalkNTalk"`
`version`	string	API version in use
`organisation.id`	string (UUID)	Your organisation's unique identifier
`organisation.name`	string	Organisation display name
`organisation.slug`	string	URL-safe identifier

Code Examples

curl https://api.talkntalk.africa/v1/ \
  -H "Authorization: Bearer tk_live_xxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxx"

Error Responses

Status	Meaning
`401 Unauthorized`	Missing or invalid API key

{
  "detail": "Authentication credentials were not provided."
}

{
  "detail": "Invalid or revoked API key."
}

Overview API Keys