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

bash
curl "https://console.brevily.com/api/NORTHWIND/tags/01JC6Y8QH2M4ZK7T9VRW3XNB5D" \  -H "x-api-key: brv_ak_7Fq2Lw9xK3" \  -H "x-api-secret: $BREVILY_SECRET"

Example answer

json
{  "id": "01JC6Y8QH2M4ZK7T9VRW3XNB5D",  "name": "example",  "kind": "PERSON",  "links": 1,  "clicks": 1,  "days": 1,  "createdBy": "example",  "createdOn": "2026-11-05T09:41:00Z"}

Made-up values.

PathPermalink

Path parameters
NameTypeRequiredDescriptionAllowed values
ORGstringrequiredYour organisation’s code.3 to 20 characters
tagstringrequired—

QueryPermalink

Query parameters
NameTypeRequiredDescriptionAllowed values
kindstringoptionalNarrows the answer: ?kind=<value>, or ?kind=eq:<value>.—
qstringoptionalA search term.—
sortstringoptionalOne of name, kind, created, then :asc or :desc (?sort=name:desc).—

AnswerPermalink

OrganisationTag

Answer fields
NameTypeDescriptionAllowed values
idstringThe tag’s id.—
namestringThe tag as typed.—
kindstringWhat the tag names: PERSON, TEAM, CAMPAIGN, CHANNEL, PRODUCT, REGION or CUSTOM.PERSON, TEAM, CAMPAIGN, CHANNEL, PRODUCT, REGION, CUSTOM
linksintegerLinks carrying it (deleted ones not counted).—
clicksintegerHuman clicks on those links over days; null when the plan keeps no history.or null
daysintegerThe days clicks covers: 30, or fewer when the plan keeps fewer.—
createdBystringWho made it, by name ("Support" for Brevily’s support team); null when unknown.or null
createdOndate-timeWhen it was made.—

ErrorsPermalink

Errors
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.