List tags

Retrieves a paginated list of tags with optional search filtering.

GET /v0/tags

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
});

// Automatically fetches more pages as needed.
for await (const tag of client.tags.list()) {
  console.log(tag.id);
}

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"
    }
  ],
  "pagination": {
    "skip": 0,
    "limit": 25,
    "total": 100,
    "totalPages": 4,
    "totalCount": 100
  }
}

Authorizations

x-api-key · string · header · required

Your unique Avido API key

x-application-id · string · header · required

Your unique Avido Application ID

Query Parameters

skip · integer · default: 0

Number of items to skip before starting to collect the result set.

Required range: 0 <= x <= 9007199254740991

Example:

0

limit · integer

Number of items to include in the result set.

Required range: 1 <= x <= 100

Example:

25

orderBy · string · default: createdAt

Field to order by in the result set.

Example:

"createdAt"

orderDir · enum<string> · default: desc

Order direction.

Available options: asc, desc

Example:

"desc"

search · string

Search in tag name and description

Example:

"API"

Response

200

application/json

Successfully retrieved tags

Paginated response containing tags

data · Tag · object[] · required

Show child attributes

pagination · PaginationResponse · object · required

Pagination metadata returned in a paginated response.

Show child attributes