Get projects

Gets the list of all projects registered in your Platform account.

• Use both the limit and offset values to retrieve the data according to the defined criteria.
• You can also filter results by certain values for a quicker search.
  

Refer to the API design section for more details about filters and pagination.

Query Parameters
status string You can use the status parameter as a filter to retrieve only those projects that respond to your interest. Available statuses: Draft, Active, Cancelled or Finished. You can also filter projects by 2 or more status if needed using the ',' as separator. Example: status=active,draft
title string The API will return the projects that contain the title you specify. For instance, if your project title is "My project", you can use title=my to retrieve it.
externalId string Use the externalId parameter to filter the projects the ID on your system. The API will return the projects that matches exactly the ID you specify.
createdBefore string Filter the projects that were created before the date you specify. Example: createdBefore=2025-02-26T12:45:54 or createdBefore=2025-02-26
createdAfter string Filter the projects that were created after the date you specify. Example: createdAfter=2025-02-26T12:45:54 or createdAfter=2025-02-26
fetchMetadata integer Set this parameter to '1' to retrieve the metadata associated for each project.
limit string Indicates the amount of projects you want to retrieve per page. Maximum value is 500.
offset string Number of projects to skip before starting to return the projects. Default value is 0. You can use 'limit' and 'offset' together to paginate the results. Example: page 0 could be: limit=10&offset=0, and the page 1 could be: limit=10&offset=10.

Responses

200 All projects matching criteria Schema — OPTIONAL projects object[] — OPTIONAL id integer — OPTIONAL externalId string — OPTIONAL title string — OPTIONAL userId integer — OPTIONAL companyId integer — OPTIONAL status string — OPTIONAL creationDate date-time — OPTIONAL It takes the date when the project was created. deadline date-time — OPTIONAL finishedAt date-time — OPTIONAL This is the date when the project status transitions from "active" to "finished". metadata object — OPTIONAL This is the metadata that has been added to the project. metadata object — OPTIONAL previousPage integer — OPTIONAL currentPage integer — OPTIONAL nextPage integer — OPTIONAL itemsPerPage integer — OPTIONAL previousPageLink string — OPTIONAL nextPageLink string — OPTIONAL