Tags
REST reference

Tags API

Conversation tags.

View as Markdown

List tags

GET/v1/tags

Lists all workspace tags (unpaginated), ordered by name.

Required scope: conversations:read.

Request
cURL
curl "https://api.asks.app/v1/tags" \
  -H "Authorization: Bearer $ASKS_API_KEY"
Response 200
JSON
{
  "object": "list",
  "data": [
    {
      "object": "tag",
      "id": "string",
      "name": "string",
      "color": {},
      "is_active": true,
      "created_at": {}
    }
  ],
  "has_more": true,
  "next_cursor": {}
}

Create a tag

POST/v1/tags

Required scope: conversations:write.

Request body
namestringrequired
colorstring
Request
cURL
curl -X POST "https://api.asks.app/v1/tags" \
  -H "Authorization: Bearer $ASKS_API_KEY" \
  -H "Content-Type: application/json" \
  -d '{
    "name": "string",
    "color": "string"
  }'
Response 201
JSON
{
  "object": "tag",
  "id": "string",
  "name": "string",
  "color": {},
  "is_active": true,
  "created_at": {}
}

Update a tag

PATCH/v1/tags/{id}

Required scope: conversations:write.

Request body
namestring
colorstringnull
is_activeboolean
Request
cURL
curl -X PATCH "https://api.asks.app/v1/tags/<id>" \
  -H "Authorization: Bearer $ASKS_API_KEY" \
  -H "Content-Type: application/json" \
  -d '{
    "name": "string",
    "color": {},
    "is_active": true
  }'
Response 200
JSON
{
  "object": "tag",
  "id": "string",
  "name": "string",
  "color": {},
  "is_active": true,
  "created_at": {}
}

Delete a tag

DELETE/v1/tags/{id}

Required scope: conversations:write.

Request
cURL
curl -X DELETE "https://api.asks.app/v1/tags/<id>" \
  -H "Authorization: Bearer $ASKS_API_KEY"
Response 200
JSON
{
  "object": "tag",
  "id": "string",
  "deleted": true
}
← Previous
Knowledge base
Next →
Canned responses