List tags — Brigg developers

Access & visibility

Allow customers.ListTags on your API key.

Workspace access by default. Private member data requires approved member delegation through Brigg-Act-As; the key supplies permissions while private ownership and project boundaries remain enforced.

Set up authentication · Choose permissions

Request fields

Send a JSON object with the following fields. Required fields must be included; omit optional fields you do not need.

vocabulary_idstringOptional

Select the vocabulary for the record's resource_type and field. Use vocabulary_id, not its display label. customers.ListTagVocabularies.

At least 1 character. At most 200 characters.

Use stored keys, not labels

List tag vocabularies and select the record's resource_type and field.
List tags with its vocabulary_id.
Store the tag's key in the record field; use label and color only for display.

Renaming a label does not change its stored key. System tags are protected from update and deletion. Deleting a user tag also removes that key from affected records; entries_stripped reports how many records changed. Removing one record's tag assignment instead uses that record's update operation.

Response

Returns 200 OK with a JSON body.

This operation has no continuation cursor. An empty items array means no matching visible results were returned.

itemsarray of TagRequired

Tags in the selected vocabulary. This operation has no cursor pagination.

Item fields

vocabulary_idstringRequired

Vocabulary containing this tag. The pair vocabulary_id and key identifies a tag.

keystringRequired

Stable stored value used when assigning the tag to a record; do not send its display label instead.

labelstring or nullRequired

Human-readable tag name, which can change without changing its key.

colorstring or nullRequired

Display color assigned to the tag, or null when no color was selected.

systembooleanRequired

Whether this is a built-in tag protected from editing and deletion.

Errors & retries

This operation reads data. It needs no idempotency key and can be retried after a transient failure.

For rate limits, follow the server’s retry guidance and back off. See HTTP errors and safe retries and limits.

HTTP status	Code	What to do
400	`invalid_json`	Send a JSON object with Content-Type: application/json.
400	`invalid_input`	Check the request fields and types.
401	`invalid_key`	The workspace API key is missing, invalid or revoked.
403	`forbidden`	Check the key’s operation and resource grants. If Brigg-Act-As is supplied, the key must be authorized to delegate to that member.
404	`not_found`	The requested operation or resource is not available to this credential.
429	`rate_limited`	Wait for Retry-After before retrying.

Next steps

Download OpenAPI · Versioning & retirement

JSON schemas

Use the complete schemas for validation or client generation.

Full request JSON schema

{
  "type": "object",
  "properties": {
    "vocabulary_id": {
      "type": "string",
      "minLength": 1,
      "maxLength": 200,
      "description": "Select the vocabulary for the record's resource_type and field. Use vocabulary_id, not its display label. [customers.ListTagVocabularies](/developers/reference/customers/ListTagVocabularies)."
    }
  },
  "additionalProperties": false,
  "examples": [
    {}
  ]
}

Full response JSON schema

{
  "type": "object",
  "properties": {
    "items": {
      "type": "array",
      "items": {
        "type": "object",
        "properties": {
          "vocabulary_id": {
            "type": "string",
            "description": "Vocabulary containing this tag. The pair vocabulary_id and key identifies a tag.",
            "examples": [
              "core:Company.tags"
            ]
          },
          "key": {
            "type": "string",
            "description": "Stable stored value used when assigning the tag to a record; do not send its display label instead.",
            "examples": [
              "priority"
            ]
          },
          "label": {
            "type": [
              "string",
              "null"
            ],
            "description": "Human-readable tag name, which can change without changing its key.",
            "examples": [
              "Priority"
            ]
          },
          "color": {
            "type": [
              "string",
              "null"
            ],
            "description": "Display color assigned to the tag, or null when no color was selected.",
            "examples": [
              null
            ]
          },
          "system": {
            "type": "boolean",
            "description": "Whether this is a built-in tag protected from editing and deletion.",
            "examples": [
              false
            ]
          }
        },
        "required": [
          "vocabulary_id",
          "key",
          "label",
          "color",
          "system"
        ],
        "additionalProperties": false,
        "title": "Tag"
      },
      "description": "Tags in the selected vocabulary. This operation has no cursor pagination."
    }
  },
  "required": [
    "items"
  ],
  "additionalProperties": false,
  "examples": [
    {
      "items": [
        {
          "vocabulary_id": "core:Company.tags",
          "key": "priority",
          "label": "Priority",
          "color": null,
          "system": false
        }
      ]
    }
  ]
}

Try the request

Use your API key in a server environment.

Act as a memberRequires administrator-approved delegation.

Fictional values. Replace IDs and business details with values from your workspace.

Request

cURL

curl 'https://api.brigg.app/v1/operations/customers.ListTags' \
  -H "Authorization: Bearer $BRIGG_API_KEY" \
  -H 'Content-Type: application/json' \
  --data-raw '{}'

TypeScript

const response = await fetch("https://api.brigg.app/v1/operations/customers.ListTags", {
  method: "POST",
  headers: {
    Authorization: `Bearer ${process.env.BRIGG_API_KEY}`,
    "Content-Type": "application/json",
  },
  body: JSON.stringify({}),
});
const result = await response.json();
if (!response.ok) throw new Error(`${response.status}: ${result.error} — ${result.message}`);
console.log(result);

Python

import json
import os
from urllib.request import Request, urlopen
from urllib.error import HTTPError

payload = {}
request = Request(
    "https://api.brigg.app/v1/operations/customers.ListTags",
    data=json.dumps(payload).encode("utf-8"),
    headers={
        "Authorization": f"Bearer {os.environ['BRIGG_API_KEY']}",
        "Content-Type": "application/json",
    },
    method="POST",
)
try:
    with urlopen(request) as response:
        print(json.load(response))
except HTTPError as error:
    print(error.code, json.load(error))
    raise

cURL

curl 'https://api.brigg.app/v1/operations/customers.ListTags' \
  -H "Authorization: Bearer $BRIGG_API_KEY" \
  -H 'Content-Type: application/json' \
  -H "Brigg-Act-As: $BRIGG_ACT_AS" \
  --data-raw '{}'

TypeScript

const actAs = process.env.BRIGG_ACT_AS;
if (!actAs) throw new Error("Set BRIGG_ACT_AS to an approved member account ID.");

const response = await fetch("https://api.brigg.app/v1/operations/customers.ListTags", {
  method: "POST",
  headers: {
    Authorization: `Bearer ${process.env.BRIGG_API_KEY}`,
    "Content-Type": "application/json",
    "Brigg-Act-As": actAs,
  },
  body: JSON.stringify({}),
});
const result = await response.json();
if (!response.ok) throw new Error(`${response.status}: ${result.error} — ${result.message}`);
console.log(result);

Python

import json
import os
from urllib.request import Request, urlopen
from urllib.error import HTTPError

payload = {}
request = Request(
    "https://api.brigg.app/v1/operations/customers.ListTags",
    data=json.dumps(payload).encode("utf-8"),
    headers={
        "Authorization": f"Bearer {os.environ['BRIGG_API_KEY']}",
        "Content-Type": "application/json",
        "Brigg-Act-As": os.environ["BRIGG_ACT_AS"],
    },
    method="POST",
)
try:
    with urlopen(request) as response:
        print(json.load(response))
except HTTPError as error:
    print(error.code, json.load(error))
    raise

200 OK Response example

{
  "items": [
    {
      "vocabulary_id": "core:Company.tags",
      "key": "priority",
      "label": "Priority",
      "color": null,
      "system": false
    }
  ]
}

Illustrative values, not a live response.