Skip to main content
GET
/
v3
/
tags
/
{id}
Get specific tag
curl --request GET \
  --url https://{region}.affinda.com/v3/tags/{id} \
  --header 'Authorization: Bearer <token>'
{
  "id": 1,
  "name": "<string>",
  "workspace": "mEFayXdO",
  "documentCount": 1
}

Authorizations

​
Authorization
string
header
required

Basic authentication using an API key, e.g. {Authorization: Bearer aff_0bb4fbdf97b7e4111ff6c0015471094155f91}. You can find your API key within the Settings page of the Affinda web app. You can obtain an API key by signing up for a free trial.

Path Parameters

​
id
integer
required

Tag's ID Uniquely identify a tag.

Required range: x >= 1
Example:

1

Response

Successfully retrieved tag.

​
id
integer
required

Uniquely identify a tag.

Required range: x >= 1
Example:

1

​
name
string
required
​
workspace
string
required

Uniquely identify a workspace.

Example:

"mEFayXdO"

​
documentCount
integer
required

Number of documents tagged with this.

Required range: x >= 0