Get all users

The Get all users API enables users to get all users in their Rocketlane instances using advanced filtering options. This API is intended to provide a flexible and fast means of getting users related data based on various parameters.

Developers can integrate the users search feature into their applications and platforms by using this API. You can fine-tune your searches and retrieve the users data you need for integration into your applications or platforms by using the available parameters.

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 users. The response body is paginated, and you can control the pagination using the limit and pageToken parameters.

Pagination

The Get all users 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 nextPageToken.

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 users API allows users to build elaborate search queries to return specific subsets of users 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.

Please refer to the link here for more information on how to construct the filtering criteria for users related fields.

Custom Field Filtering

The Get all users API offers custom field filtering in addition to the regular filtering options.

📘

Note

Custom fields are supported only for users of type TEAM_MEMBER. Therefore, custom filtering will only be applied to users of type TEAM_MEMBER.

Users can utilise custom field filtering to define and apply their own USER fields as search criteria. This powerful feature allows users to search for users based on custom USER fields, allowing the API to be tailored to a variety of use cases where default fields may be insufficient.

Please refer to the below table for more information on how to construct the filtering criteria for custom fields.

For more detailed examples related to searching/ filtering using custom fields refer to the search section.

The field_id can be fetched from this API. Additional parameters can be passed to fetch fields associated with users, which can then be used to perform searches on the users.

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 users 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.