Get all projects
GET {{baseUrl}}/projects?cursor=<string>&limit=<integer>&filter_id=<integer>&status=<string>&phase_id=<integer>&include_archived=<boolean>
Returns all projects. This is a cursor-paginated endpoint. For more information, please refer to our documentation on pagination.
Request Params
Key | Datatype | Required | Description |
---|---|---|---|
cursor | string | For pagination, the marker (an opaque string value) representing the first item on the next page | |
limit | string | For pagination, the limit of entries to be returned. If not provided, 100 items will be returned. | |
filter_id | string | The ID of the filter to use | |
status | string | If supplied, includes only projects with the specified statuses. Possible values are open , completed , canceled and deleted . By default deleted projects are not returned. | |
phase_id | string | If supplied, only projects in specified phase are returned | |
include_archived | string | If supplied with true then archived projects are also included in the response. By default only not archived projects are returned. |
HEADERS
Key | Datatype | Required | Description |
---|---|---|---|
Accept | string |
RESPONSES
status: OK
{"success":true,"data":[{"id":8,"title":"Project","description":"Project Description","status":"open","status_change_time":"2023-09-12 11:12:18.110","start_date":"2023-09-18","end_date":"2024-03-04","owner_id":19,"add_time":"2023-09-12 11:12:18.110","update_time":"2023-09-14 05:45:40.084","labels":[13,14],"archive_time":"2023-09-15 11:12:18.110","deal_ids":[1,2],"person_id":2,"org_id":3,"board_id":1,"phase_id":1}],"additional_data":{"next_cursor":"eyJhY3Rpdml0aWVzIjoyN30"}}