GitScrum / Docs

Labels

Create, update, and manage project labels. Attach and detach labels from tasks.

REST API — All endpoints require authentication via Bearer token. Include Authorization: Bearer {token} in every request. Tokens are managed in GitScrum Settings → API. Base URL: https://services.gitscrum.com — All request paths in this documentation are relative to this base URL.

Labels help categorize and filter tasks across projects. Manage labels at the workspace level and attach them to individual tasks.

List labels

GET /projects-labels?company_slug={slug}

Returns all labels in the workspace.

Query parameters

ParameterTypeRequiredDescription
company_slugstringYesWorkspace identifier
curl -X GET "https://services.gitscrum.com/projects-labels?company_slug=acme-corp" \
  -H "Authorization: Bearer {token}" \
  -H "Content-Type: application/json"

Response 200 OK

{
  "data": [
    {
      "id": 1,
      "slug": "bug",
      "title": "Bug",
      "color": "EF4444"
    },
    {
      "id": 2,
      "slug": "feature",
      "title": "Feature",
      "color": "3B82F6"
    },
    {
      "id": 3,
      "slug": "urgent",
      "title": "Urgent",
      "color": "F59E0B"
    }
  ]
}

Create label

POST /projects-labels?company_slug={slug}

Creates a new label in the workspace.

Query parameters

ParameterTypeRequiredDescription
company_slugstringYesWorkspace identifier

Request body

FieldTypeRequiredDescription
titlestringYesLabel name
colorstringYesHex color without # (e.g., FF5733)
curl -X POST "https://services.gitscrum.com/projects-labels?company_slug=acme-corp" \
  -H "Authorization: Bearer {token}" \
  -H "Content-Type: application/json" \
  -d '{
    "title": "Design",
    "color": "8B5CF6"
  }'

Response 201 Created

{
  "data": {
    "id": 4,
    "slug": "design",
    "title": "Design",
    "color": "8B5CF6"
  }
}

Update label

PUT /projects-labels/{slug}?company_slug={slug}

Updates an existing label.

Path parameters

ParameterTypeRequiredDescription
slugstringYesLabel identifier

Query parameters

ParameterTypeRequiredDescription
company_slugstringYesWorkspace identifier

Request body

FieldTypeRequiredDescription
titlestringNoNew label name
colorstringNoNew hex color without #
curl -X PUT "https://services.gitscrum.com/projects-labels/design?company_slug=acme-corp" \
  -H "Authorization: Bearer {token}" \
  -H "Content-Type: application/json" \
  -d '{
    "title": "UI Design",
    "color": "7C3AED"
  }'

Response 200 OK

{
  "data": {
    "id": 4,
    "slug": "design",
    "title": "UI Design",
    "color": "7C3AED"
  }
}

Delete label

DELETE /projects-labels/{slug}?company_slug={slug}

Permanently deletes a label and removes it from all tasks.

Path parameters

ParameterTypeRequiredDescription
slugstringYesLabel identifier

Query parameters

ParameterTypeRequiredDescription
company_slugstringYesWorkspace identifier
curl -X DELETE "https://services.gitscrum.com/projects-labels/design?company_slug=acme-corp" \
  -H "Authorization: Bearer {token}"

Attach label

POST /projects-labels/{labelslug}/attach?companyslug={slug}&project_slug={slug}

Attaches a label to a task. No effect if already attached.

Path parameters

ParameterTypeRequiredDescription
label_slugstringYesLabel identifier

Query parameters

ParameterTypeRequiredDescription
company_slugstringYesWorkspace identifier
project_slugstringYesProject identifier

Request body

FieldTypeRequiredDescription
task_uuidstringYesTask unique identifier
curl -X POST "https://services.gitscrum.com/projects-labels/feature/attach?company_slug=acme-corp&project_slug=web-platform" \
  -H "Authorization: Bearer {token}" \
  -H "Content-Type: application/json" \
  -d '{
    "task_uuid": "task-uuid-abc123"
  }'

Detach label

DELETE /projects-labels/{labelslug}/detach?companyslug={slug}&project_slug={slug}

Removes a label from a task. No effect if not attached.

Path parameters

ParameterTypeRequiredDescription
label_slugstringYesLabel identifier

Query parameters

ParameterTypeRequiredDescription
company_slugstringYesWorkspace identifier
project_slugstringYesProject identifier

Request body

FieldTypeRequiredDescription
task_uuidstringYesTask unique identifier
curl -X DELETE "https://services.gitscrum.com/projects-labels/feature/detach?company_slug=acme-corp&project_slug=web-platform" \
  -H "Authorization: Bearer {token}" \
  -H "Content-Type: application/json" \
  -d '{
    "task_uuid": "task-uuid-abc123"
  }'

Field reference

FieldTypeDescription
idintegerLabel ID
slugstringURL-friendly label identifier
titlestringLabel display name
colorstringHex color code without #