Skip to main content

Get Projects

Retrieve a paginated list of projects in your organisation.

Endpoint​

GET /projects

Parameters​

ParameterTypeDescriptionRequired
pageintegerThe page number for pagination (default: 1)No

Response​

A successful response will return a 200 OK status code and a JSON object containing the list of projects and pagination metadata.

{
  "data": [
    {
      "uuid": "9f2cff7e-3113-4ed4-b082-d6e40f2e194c",
      "name": "New API Project",
      "colour": {
        "name": "LILAC",
        "gradient": {
          "hex_from": "#D1C4E9",
          "hex_to": "#EDE7F6"
        }
      },
      "image_url": null,
      "prefix": "UTT",
      "sprints": {
        "enabled": true,
        "name": {
          "singular": "sprint",
          "plural": "sprints"
        },
        "default_duration_weeks": 2
      },
      "timesheet": {
        "enabled": false
      },
      "time_estimates": {
        "enabled": true
      },
      "story_points": {
        "enabled": false
      },
      "task_form": {
        "enabled": false,
        "title": null,
        "description": null,
        "success_title": null,
        "success_description": null
      },
      "cost_tracking": {
        "enabled": false
      },
      "auto_archiving": {
        "enabled": false,
        "after_days": 14
      },
      "stagnancy_indicator": {
        "enabled": false,
        "phases_days": {
          "sitting": 2,
          "idle": 4,
          "stagnating": 7,
          "stale": 14
        }
      },
      "email_to_task": {
        "enabled": false,
        "key": null
      },
      "sign_offs": {
        "enabled": true
      },
      "client_portal": {
        "enabled": true,
        "allow_client_file_uploads": true
      },
      "created_at": "2024-11-23 14:58:31",
      "updated_at": "2025-01-07 12:29:06"
    },
    ...
  ],
  "pagination": {
    "current_page": 1,
    "per_page": 20,
    "total_pages": 2,
    "total_items": 24
  }
}