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.


GET/api/v2/projects/categories/

List all Categories

Retrieve a list of all project categories.

Query Parameters

  • Name
    q
    Type
    string
    Description

    Search by category name.

Request

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

Response

{
  "count": 3,
  "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" }
  ]
}

POST/api/v2/projects/categories/

Create a Category

Create a new project category.

  • Name
    name
    Type
    string
    Description

    The category name. Required.

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"
  }'

PUT/api/v2/projects/categories/:id/

Update a Category

Rename an existing project category.

Request

curl -X PUT "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>"

Was this page helpful?