The Get all projects API enables users to find projects in their Rocketlane instances using advanced filtering options. This API is intended to provide a flexible and fast means of getting project data based on various parameters.
Developers can integrate project search features into their applications and platforms by using this API. You can fine-tune your searches and retrieve the project data you need for integration into your applications or platforms by using the available parameters.
Note
Archived projects are not reflected in the response body.
The includeFields param can be used to customize the response.You can fine-tune your searches and retrieve the project related data you need for integration into your applications or platforms by using filters.
You can use any combination of these parameters to execute searches based on your specifications. In addition to filters, sortBy and sortOrder can be used to sort the projects. The response body is paginated, and you can control the pagination using the limit and pageToken parameters.
Pagination
The Get All Projects API accommodates pagination in the response body. The pageSize option can be used to restrict the amount of responses displayed/available in a single request. Additionally, if there are more entries than the ones accessible in the answer, the response(s) may contain the pageToken.
Please refer to the pagination section for further information on this.
Filtering
The capacity to execute more sophisticated and nuanced searches on a dataset by combining numerous criteria and conditions is referred to as filtering.
Complex filtering in the context of the Get All Projects API allows users to build elaborate search queries to return specific subsets of projects that satisfy specific requirements. By catering to a wide range of use cases, this enhanced filtering functionality considerably increases the API's utility and versatility.
The API reference includes a comprehensive range of filtering options.
Custom Field Filtering
The Get All Projects API offers custom field filtering in addition to the regular filtering options.
Users can utilise custom field filtering to define and apply their own project fields as search criteria. This powerful feature allows users to search for projects based on custom project fields, allowing the API to be tailored to a variety of use cases where default fields may be insufficient.
We can provide both project and task custom fields to the API, and it will return the appropriate response.
| Type | Description |
|---|---|
| Project | Custom project fields |
| Task | Custom task fields |
Please refer to the below table for more information on how to construct the filtering criteria for custom fields.
| Field name | Text | Number | Yes/No | Date | Single Selection | Multi Selection | Rating |
|---|---|---|---|---|---|---|---|
| {type}.field.{field_id}.value | ☑️ | ☑️ | ☑️ | ☑️ | ☑️ | ||
| {type}.field.{field_id}.contains | ☑️ | ||||||
| {type}.field.{field_id}.notContains | ☑️ | ||||||
| {type}.field.{field_id}.greaterThan | ☑️ | ☑️ | ☑️ | ||||
| {type}.field.{field_id}.lessThan | ☑️ | ☑️ | ☑️ | ||||
| {type}.field.{field_id}.greaterThanEqual | ☑️ | ☑️ | ☑️ | ||||
| {type}.field.{field_id}.lessThanEqual | ☑️ | ☑️ | ☑️ | ||||
| {type}.field.{field_id}.isEmpty | ☑️ | ☑️ | ☑️ | ☑️ | ☑️ | ☑️ | ☑️ |
| {type}.field.{field_id}.isNotEmpty | ☑️ | ☑️ | ☑️ | ☑️ | ☑️ | ☑️ | ☑️ |
| {type}.field.{field_id}.isTrue | ☑️ | ||||||
| {type}.field.{field_id}.isFalse | ☑️ | ||||||
| {type}.field.{field_id}.oneOf | ☑️ | ☑️ | |||||
| {type}.field.{field_id}.noneOf | ☑️ | ☑️ |
The field_id can be fetched from this API. Additional parameters can be passed to fetch fields associated with projects or tasks, which can then be used to perform searches on the projects.
For more information about this, please refer to the custom fields section.
Criteria Match
In addition to standard filtering and custom field filtering, the Get All Projects API also supports the use of AND and OR conditions for more advanced filtering options. Users can combine different filters and custom field queries with these logical operators to build complex yet accurate search queries.
In case any issues arise or further assistance is required, please refer to the error handling section or reach out to our support team at [email protected] for a prompt resolution.