Tags › Get a tag
Tags
Get a tag
GET/api/{ORG}/tags/{tag}Permalink
Answers the OrganisationTag.
- Permission
- Tags · view
- Plan
- Plans that include the API: Pricing
- Retry
- Safe: a read changes nothing
Example request
curl "https://console.brevily.com/api/NORTHWIND/tags/01JC6Y8QH2M4ZK7T9VRW3XNB5D" \ -H "x-api-key: brv_ak_7Fq2Lw9xK3" \ -H "x-api-secret: $BREVILY_SECRET"const res = await fetch("https://console.brevily.com/api/NORTHWIND/tags/01JC6Y8QH2M4ZK7T9VRW3XNB5D", { headers: { "x-api-key": "brv_ak_7Fq2Lw9xK3", "x-api-secret": process.env.BREVILY_SECRET, },});const answer = await res.json();Example answer
{ "id": "01JC6Y8QH2M4ZK7T9VRW3XNB5D", "name": "example", "kind": "PERSON", "links": 1, "clicks": 1, "days": 1, "createdBy": "example", "createdOn": "2026-11-05T09:41:00Z"}{ "code": "VALIDATION_FAILED", "message": "Check the form. kind: Not a value this field takes.", "details": { "fields": { "kind": "Not a value this field takes." } }, "requestId": "18188559082372202519"}Made-up values.
PathPermalink
| Name | Type | Required | Description | Allowed values |
|---|---|---|---|---|
ORG | string | required | Your organisation’s code. | 3 to 20 characters |
tag | string | required | — |
QueryPermalink
| Name | Type | Required | Description | Allowed values |
|---|---|---|---|---|
kind | string | optional | Narrows the answer: ?kind=<value>, or ?kind=eq:<value>. | — |
q | string | optional | A search term. | — |
sort | string | optional | One of name, kind, created, then :asc or :desc (?sort=name:desc). | — |
AnswerPermalink
OrganisationTag
| Name | Type | Description | Allowed values |
|---|---|---|---|
id | string | The tag’s id. | — |
name | string | The tag as typed. | — |
kind | string | What the tag names: PERSON, TEAM, CAMPAIGN, CHANNEL, PRODUCT, REGION or CUSTOM. | PERSON, TEAM, CAMPAIGN, CHANNEL, PRODUCT, REGION, CUSTOM |
links | integer | Links carrying it (deleted ones not counted). | — |
clicks | integer | Human clicks on those links over days; null when the plan keeps no history. | or null |
days | integer | The days clicks covers: 30, or fewer when the plan keeps fewer. | — |
createdBy | string | Who made it, by name ("Support" for Brevily’s support team); null when unknown. | or null |
createdOn | date-time | When it was made. | — |
ErrorsPermalink
| Status | Code | When |
|---|---|---|
| 400 | VALIDATION_FAILED |
A field, a parameter or the body is wrong; details.fields says which. |
| 401 | UNAUTHENTICATED |
No key, a key that does not match, or one expired or revoked. |
| 403 | ACCESS_DENIED |
The key lacks Tags · view, or the organisation’s plan does not include it. |
| 404 | NOT_FOUND |
No organisation with that code for this key, or no such record in it. |
| 429 | RATE_LIMITED |
Too many calls: wait Retry-After seconds. |
Rate limitsPermalink
Counted with every other call of the organisation, by plan: Pricing. The answer carries RateLimit-Limit, RateLimit-Remaining and RateLimit-Reset; more on rate limits.
Type a call, a field or a guide.