GET
/
api
/
tags
/
{tagId}
Get tag by ID
curl --request GET \
  --url https://api.atendai.com/api/tags/{tagId} \
  --header 'Authorization: Bearer <token>'
{
  "id": "<string>",
  "name": "<string>",
  "color": "<string>",
  "kanban": 123,
  "order": 123,
  "companyId": "<string>",
  "createdAt": "<string>",
  "updatedAt": "<string>",
  "contacts": [
    {
      "id": "<string>",
      "name": "<string>",
      "number": "<string>",
      "email": "<string>",
      "profilePicUrl": "<string>",
      "isGroup": true,
      "isAdmin": true,
      "isOpen": true,
      "isBotEnabled": true,
      "utmCampaign": "<string>",
      "utmContent": "<string>",
      "utmMedium": "<string>",
      "utmSource": "<string>",
      "utmTerms": "<string>",
      "active": true,
      "channel": "<string>",
      "whatsappId": "<string>",
      "companyId": "<string>",
      "createdAt": "<string>",
      "updatedAt": "<string>"
    }
  ]
}

Authorizations

Authorization
string
header
required

Bearer authentication header of the form Bearer <token>, where <token> is your auth token.

Path Parameters

tagId
string
required

ID of the tag to retrieve

Response

Successful response

id
string
required
name
string
required
color
string
required
order
integer
required
companyId
string
required
createdAt
string
required
updatedAt
string
required
kanban
integer
contacts
object[]