COcontentstudio
🏷️ Labels

Get labels for a workspace

Changed on

Retrieve paginated list of labels for a specific workspace, sorted alphabetically by name.

get/api/v1/workspaces/{workspace_id}/labels

Request

  • Base URL
    https://api.contentstudio.io
  • URL
    https://api.contentstudio.io/api/v1/workspaces/{workspace_id}/labels
  • Auth
    API key in header X-API-Key

Path parameters

workspace_idstring required
Example:610a1e660cb41530ca40d372

Workspace ID

Query parameters

pageinteger
Example:1

Page number for pagination

per_pageinteger
Example:10

Number of items per page (max: 100)

searchstring
Example:marketing

Search term to filter labels by name (case-insensitive partial match)

Response

Labels retrieved successfully

statusboolean
messagestring
current_pageinteger
per_pageinteger
totalinteger
last_pageinteger
frominteger
tointeger

Example response

{
  "status": true,
  "message": "Labels retrieved successfully",
  "current_page": 1,
  "per_page": 10,
  "total": 25,
  "last_page": 3,
  "from": 1,
  "to": 10,
  "data": [
    {
      "id": "625d06734ceb636c2f5e7743",
      "_id": "625d06734ceb636c2f5e7743",
      "name": "Urgent",
      "color": "color_1"
    }
  ]
}

Changes