Project

Project Object

Field	Type	Description
id	snowflake	the project's id
organisation_id	snowflake	the id of the owning organisation
code	string	the project's short code (max 12 characters)
name	string	the project's name (max 200 characters)
description	string	a description of the project
readme	string	the project's readme content (max 64000 characters)
status	project status	the current status of the project
open_milestone_count	integer	number of open milestones in the project
closed_milestone_count	integer	number of closed milestones in the project
open_work_item_count	integer	number of open work items in the project
closed_work_item_count	integer	number of closed work items in the project
work_item_types_count	object<snowflake, work item type count>	dictionary mapping work item type ids to their counts (full response only)
document_count	integer	number of documents in the project
created_at	ISO8601 timestamp	when the project was created (full response only)
created_by	user object	the user who created the project (full response only)
closed_at	ISO8601 timestamp	when the project was closed (full response only)
closed_by	user object	the user who closed the project (full response only)
permissions	object<permission key, boolean>	permission flags for the current user (full response only)

Project Object (partial)

When returned in a partial context, the project object only includes:

Field	Type	Description
id	snowflake	the project's id
organisation_id	snowflake	the id of the owning organisation
code	string	the project's short code
name	string	the project's name
description	string	a description of the project
status	project status	the current status of the project
open_milestone_count	integer	number of open milestones
closed_milestone_count	integer	number of closed milestones
open_work_item_count	integer	number of open work items
closed_work_item_count	integer	number of closed work items
document_count	integer	number of documents

Project Status

The status field indicates the current state of the project.

Value	Description
open	the project is open and active
closed	the project is closed

Project Permission Keys

The permissions object contains boolean values for the following permission keys:

Permission Key	Description
VIEW_PROJECTS	allows viewing projects
ADMIN_PROJECTS	allows administering projects
SHARE_PROJECTS	allows sharing projects
VIEW_WORKITEMS	allows viewing work items within the project
CREATE_WORKITEMS	allows creating work items within the project
VIEW_DOCUMENTS	allows viewing documents within the project
EDIT_DOCUMENTS	allows editing documents within the project (via share scope)

Work Item Type Count Object

Field	Type	Description
open_count	integer	number of open work items of this type
closed_count	integer	number of closed work items of this type

{
    "id": "1234567890",
    "organisation_id": "9876543210",
    "code": "PRJ",
    "name": "Example Project",
    "description": "A sample project",
    "readme": "# Project README\n\nDetails here.",
    "status": "open",
    "open_milestone_count": 5,
    "closed_milestone_count": 3,
    "open_work_item_count": 12,
    "closed_work_item_count": 8,
    "work_item_types_count": {
        "1111111111": {
            "open_count": 5,
            "closed_count": 3
        }
    },
    "document_count": 24,
    "created_at": "2020-01-01T00:00:00Z",
    "created_by": {
        "id": "5555555555"
    },
    "closed_at": null,
    "closed_by": null,
    "permissions": {
        "VIEW_PROJECTS": true,
        "ADMIN_PROJECTS": false,
        "SHARE_PROJECTS": true,
        "VIEW_WORKITEMS": true,
        "CREATE_WORKITEMS": true,
        "VIEW_DOCUMENTS": true
    }
}

Project Milestone Object

Field	Type	Description
id	snowflake	the milestone's id
organisation_id	snowflake	the id of the owning organisation
project_id	snowflake	the id of the owning project
name	string	the milestone's name
description	string	a description of the milestone
due_at	ISO8601 timestamp	the due date/time for the milestone
status	project milestone status	the current status of the milestone
open_work_item_count	integer	number of open work items linked to the milestone
closed_work_item_count	integer	number of closed work items linked to the milestone
work_item_types_count	object<snowflake, work item type count>	dictionary mapping work item type ids to their counts
created_at	ISO8601 timestamp	when the milestone was created
created_by	user object	the user who created the milestone
closed_at	ISO8601 timestamp	when the milestone was closed
closed_by	user object	the user who closed the milestone

Project Milestone Status

The status field indicates the current state of the milestone.

Value	Description
open	the milestone is open and active
closed	the milestone is closed

{
    "id": "1234567890",
    "organisation_id": "9876543210",
    "project_id": "1111111111",
    "name": "Phase 1 Completion",
    "description": "Complete all Phase 1 deliverables",
    "due_at": "2026-06-30T17:00:00Z",
    "status": "open",
    "open_work_item_count": 8,
    "closed_work_item_count": 3,
    "work_item_types_count": {
        "2222222222": {
            "open_count": 5,
            "closed_count": 2
        },
        "3333333333": {
            "open_count": 3,
            "closed_count": 1
        }
    },
    "created_at": "2026-01-15T09:00:00Z",
    "created_by": {
        "id": "5555555555"
    },
    "closed_at": null,
    "closed_by": null
}

Project Package Object

Field	Type	Description
id	snowflake	the package's id
organisation_id	snowflake	the id of the owning organisation
project_id	snowflake	the id of the owning project
code	string	the package's short code (max 12 characters)
name	string	the package's name (max 200 characters)
description	string	a description of the package
enabled	boolean	whether the package is enabled

{
    "id": "1234567890",
    "organisation_id": "9876543210",
    "project_id": "1111111111",
    "code": "PKG",
    "name": "Design Package",
    "description": "All design documents for the project",
    "enabled": true
}

Get Project

GET /projects/{project.id}

Returns the project object for the given project id. Requires the VIEW_PROJECTS permission for the project.

Error Responses

Status Code	Description
400	Bad request (invalid project or organisation)
403	Forbidden (insufficient permissions)

Update Project

PATCH /projects/{project.id}

Partially updates a project. Only the fields provided will be updated. Requires the ADMIN_PROJECTS permission for the project.

All parameters for this method are optional. Only the fields provided will be updated.

JSON Params

Field	Type	Description
code	?string	the project's short code (max 12 characters)
name	?string	the project's name (max 200 characters)
description	?string	a description of the project
readme	?string	the project's readme content (max 64000 characters)
status	?project status	the status to set for the project

Notes

• Setting status to closed requires all milestones to be closed first.
• Setting status to open requires available project quota on the organisation.

Error Responses

Status Code	Description
400	Bad request (project has open milestones)
403	Forbidden (insufficient permissions)
429	Failed to change project status (no quota)

Update Project Permission

PATCH /projects/{project.id}/permissions/{roleId}

Updates the permissions granted to a role, user, or organisation within the project. The roleId parameter accepts the id of a role, a user, or an organisation. Requires the ADMIN_PROJECTS permission for the project.

JSON Params

Field	Type	Description
permissions	object<string, permission grant type>	permissions to grant or revoke

Error Responses

Status Code	Description
400	Bad request (permissions object not provided)
403	Forbidden (insufficient permissions)
404	Not found (project does not exist)

List Project Permissions

GET /projects/{project.id}/permissions

Returns an array of permission grant objects for the project. Requires the ADMIN_PROJECTS permission for the project.

Error Responses

Status Code	Description
400	Bad request (invalid project or organisation)
403	Forbidden (insufficient permissions)

Create Milestone

POST /projects/{project.id}/milestones

Creates a new milestone in the project. Requires the ADMIN_PROJECTS permission for the project.

All parameters for this method are optional.

JSON Params

Field	Type	Description	Default
name	?string	the milestone's name	new milestone
description	?string	a description of the milestone
status	?project milestone status	the status to set for the milestone	open
due_at	?ISO8601 timestamp	the due date/time for the milestone

Error Responses

Status Code	Description
400	Bad request (project does not exist)
403	Forbidden (insufficient permissions)

Get Milestone

GET /milestones/{milestone.id}

Returns the project milestone object for the given milestone id. Requires the VIEW_PROJECTS permission for the project that owns the milestone.

Error Responses

Status Code	Description
400	Bad request (invalid milestone or organisation)
403	Forbidden (insufficient permissions)
404	Not found (milestone does not exist)

Update Milestone

PATCH /milestones/{milestone.id}

Partially updates a milestone. Only the fields provided will be updated. Requires the ADMIN_PROJECTS permission for the project that owns the milestone.

All parameters for this method are optional. Only the fields provided will be updated.

JSON Params

Field	Type	Description
name	?string	the milestone's name
description	?string	a description of the milestone
status	?project milestone status	the status to set for the milestone
due_at	?ISO8601 timestamp	the due date/time for the milestone

Notes

• Setting status to open is not allowed if the project is closed.

Error Responses

Status Code	Description
400	Bad request (cannot set milestone to open when project is closed)
403	Forbidden (insufficient permissions)

List Milestones

GET /projects/{project.id}/milestones

Returns an array of project milestone objects for the project. Requires the VIEW_PROJECTS permission for the project.

Query Parameters

Field	Type	Description
$filter	?string	OData filter expression (supports status and due_at)
$skip	?integer	number of records to skip
$top	?integer	maximum number of records to return

Error Responses

Status Code	Description
400	Bad request (invalid project or organisation)
403	Forbidden (insufficient permissions)

Create Package

POST /projects/{project.id}/packages

Creates a new package in the project. Requires the ADMIN_PROJECTS permission for the project.

JSON Params

Field	Type	Description	Default
code	?string	the package's short code (max 12 characters)
name	?string	the package's name (max 200 characters)	new package
description	?string	a description of the package
enabled	?boolean	whether the package is enabled	true

Error Responses

Status Code	Description
400	Bad request (project does not exist)
403	Forbidden (insufficient permissions)

List Packages

GET /projects/{project.id}/packages

Returns an array of project package objects for the project. Requires the VIEW_PROJECTS permission for the project.

Query Parameters

Field	Type	Description
$filter	?string	OData filter expression (supports enabled)
$skip	?integer	number of records to skip
$top	?integer	maximum number of records to return

Error Responses

Status Code	Description
400	Bad request (invalid project or organisation)
403	Forbidden (insufficient permissions)

Get Package

GET /packages/{package.id}

Returns the project package object for the given package id. Requires the VIEW_PROJECTS permission for the project that owns the package.

Error Responses

Status Code	Description
400	Bad request (invalid package or organisation)
403	Forbidden (insufficient permissions)
404	Not found (package does not exist)

Update Package

PATCH /packages/{package.id}

Partially updates a package. Only the fields provided will be updated. Requires the ADMIN_PROJECTS permission for the project that owns the package.

All parameters for this method are optional. Only the fields provided will be updated.

JSON Params

Field	Type	Description
code	?string	the package's short code (max 12 characters)
name	?string	the package's name (max 200 characters)
description	?string	a description of the package
enabled	?boolean	whether the package is enabled

Error Responses

Status Code	Description
400	Bad request (invalid package or organisation)
403	Forbidden (insufficient permissions)

Update Package Permission

PATCH /packages/{package.id}/permissions/{roleId}

Updates the permissions granted to a role, user, or organisation within the package. The roleId parameter accepts the id of a role, a user, or an organisation. Requires the ADMIN_PROJECTS permission for the package.

JSON Params

Field	Type	Description
permissions	object<string, permission grant type>	permissions to grant or revoke

Error Responses

Status Code	Description
400	Bad request (permissions object not provided)
403	Forbidden (insufficient permissions)
404	Not found (package does not exist)

List Package Permissions

GET /packages/{package.id}/permissions

Returns an array of permission grant objects for the package. Requires the ADMIN_PROJECTS permission for the package.

Error Responses

Status Code	Description
400	Bad request (invalid package or organisation)
403	Forbidden (insufficient permissions)
404	Not found (package does not exist)