Get a single tag by ID

Retrieves detailed information about a specific tag.

GET /v0/tags/{id}

JavaScript

JavaScript

import Avido from 'avido';

const client = new Avido({
  apiKey: process.env['AVIDO_API_KEY'], // This is the default and can be omitted
  applicationID: process.env['AVIDO_APPLICATION_ID'], // This is the default and can be omitted
});

const tag = await client.tags.retrieve('123e4567-e89b-12d3-a456-426614174000');

console.log(tag.data);

200

{
  "data": {
    "id": "123e4567-e89b-12d3-a456-426614174000",
    "name": "API Documentation",
    "color": "#3B82F6",
    "createdAt": "2024-01-05T12:34:56.789Z",
    "modifiedAt": "2024-01-05T12:34:56.789Z",
    "orgId": "org_123456789",
    "applicationId": "456e4567-e89b-12d3-a456-426614174000",
    "description": "Tag for API-related documentation"
  }
}

Authorizations

x-api-key · string · header · required

Your unique Avido API key

x-application-id · string · header · required

Your unique Avido Application ID

Path Parameters

id · string<uuid> · required

The unique identifier of the tag

Pattern: ^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$

Example:

"123e4567-e89b-12d3-a456-426614174000"

Response

200

application/json

Successfully retrieved tag

Successful response containing the tag data

data · Tag · object · required

A tag that can be applied to documents for organization

Show child attributes