Project Categories

Project categories allow you to organize your projects into logical groups for better navigation and reporting.

The Project Category Object

Name
id
Type
string (UUID)
Description
Unique identifier for the category.
Name
name
Type
string
Description
The category name. Required. Must be unique within your account; maximum length 256 characters.

GET/api/v2/projects/categories/

List all Categories

Retrieve a paginated list of all project categories.

Query Parameters

Name
q
Type
string
Description
Search by category name.
Name
ids
Type
string
Description
Filter by a pipe-separated list of category IDs, e.g. ?ids=<id1>|<id2>.
Name
limit
Type
integer
Description
Number of results per page. Defaults to 100, maximum 1000.
Name
offset
Type
integer
Description
Number of results to skip for pagination.

Request

curl -X GET "https://api.zeitstrom.com/api/v2/projects/categories/" \
  -H "Authorization: Token <YOUR_API_TOKEN>"

Response

{
  "count": 3,
  "next": null,
  "previous": null,
  "results": [
    { "id": "c1c1c1c1-c2c2-c3c3-c4c4-c5c5c5c5c5c5", "name": "Development" },
    { "id": "c2c2c2c2-c3c3-c4c4-c5c5-c6c6c6c6c6c6", "name": "Marketing" },
    { "id": "c3c3c3c3-c4c4-c5c5-c6c6-c7c7c7c7c7c7", "name": "Support" }
  ]
}

GET/api/v2/projects/categories/:id/

Retrieve a Category

Get details of a specific project category.

Request

curl -X GET "https://api.zeitstrom.com/api/v2/projects/categories/c1c1c1c1-c2c2-c3c3-c4c4-c5c5c5c5c5c5/" \
  -H "Authorization: Token <YOUR_API_TOKEN>"

Response

{
  "id": "c1c1c1c1-c2c2-c3c3-c4c4-c5c5c5c5c5c5",
  "name": "Development"
}

POST/api/v2/projects/categories/

Create a Category

Create a new project category.

Name
name
Type
string
Description
The category name. Required. Must be unique within your account; a duplicate name is rejected with a validation error on name.

Request

curl -X POST "https://api.zeitstrom.com/api/v2/projects/categories/" \
  -H "Authorization: Token <YOUR_API_TOKEN>" \
  -H "Content-Type: application/json" \
  -d '{
    "name": "Research & Development"
  }'

PATCH/api/v2/projects/categories/:id/

Update a Category

Rename an existing project category. PUT is also accepted for full updates. The new name must be unique within your account.

Request

curl -X PATCH "https://api.zeitstrom.com/api/v2/projects/categories/c1c1c1c1-c2c2-c3c3-c4c4-c5c5c5c5c5c5/" \
  -H "Authorization: Token <YOUR_API_TOKEN>" \
  -H "Content-Type: application/json" \
  -d '{
    "name": "Software Development"
  }'

DELETE/api/v2/projects/categories/:id/

Delete a Category

Delete a project category. Projects in this category will become uncategorized.

Request

curl -X DELETE "https://api.zeitstrom.com/api/v2/projects/categories/c1c1c1c1-c2c2-c3c3-c4c4-c5c5c5c5c5c5/" \
  -H "Authorization: Token <YOUR_API_TOKEN>"