Tags API reference

Tags endpoints of the Quackback REST API: paths, parameters, request fields and responses.

JM
James Morton
Written By James MortonLast updated 4 days ago

This is the reference for the Tags endpoints of the Quackback REST API: every endpoint, its parameters, request fields and response fields. It is generated from the API's OpenAPI description, so it matches what the API accepts.

All paths are relative to /api/v1 on your workspace's address (for example https://feedback.example.com/api/v1). Authenticate with an API key in the Authorization: Bearer qb_... header. For keys, errors, pagination and rate limits, see API overview. Every workspace also serves an interactive reference at /api/v1/docs.

Endpoints

  • GET /tags: List tags
  • POST /tags: Create a tag
  • GET /tags/{tagId}: Get a tag
  • PATCH /tags/{tagId}: Update a tag
  • DELETE /tags/{tagId}: Delete a tag

List tags

GET /api/v1/tags

Returns all tags in the workspace

Response 200: returns id, name, color, isPublic, createdAt.

Create a tag

POST /api/v1/tags

Create a new tag

Request body

Field

Type

Required

Description

name

string

Yes

PostTag name

color

string

No

PostTag color

isPublic

boolean

No

Whether customers can see this tag on the public portal. False keeps the tag internal to your team.

Response 201: returns id, name, color, isPublic, createdAt.

Get a tag

GET /api/v1/tags/{tagId}

Get a single tag by ID

Parameters

Name

In

Type

Required

Description

tagId

path

string

Yes

PostTag ID

Response 200: returns id, name, color, isPublic, createdAt.

Update a tag

PATCH /api/v1/tags/{tagId}

Update an existing tag

Parameters

Name

In

Type

Required

Description

tagId

path

string

Yes

PostTag ID

Request body

Field

Type

Required

Description

name

string

No

color

string

No

Hex color code

isPublic

boolean

No

Whether customers can see this tag on the public portal. False keeps the tag internal to your team.

Response 200: returns id, name, color, isPublic, createdAt.

Delete a tag

DELETE /api/v1/tags/{tagId}

Delete a tag by ID

Parameters

Name

In

Type

Required

Description

tagId

path

string

Yes

PostTag ID

Was this helpful?

Your feedback shapes what we write next.