Get all fields

get

https://api.rocketlane.com/api/1.0/fields

Recent Requests

Time	Status	User Agent
Retrieving recent requests…

Loading…

The Get all fields endpoint can be used to search for fields. This endpoint is particularly useful for accessing comprehensive field data and details for further analysis or display within an application. The includeFields param can be used to customize the response.

You can fine-tune your searches and retrieve the field related data you need for integration into your applications or platforms by using filters.

Filters can be provided as query parameters and have a predefined structure: key is field.operator and value is value. For instance: objectType.eq=TASK.

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.

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.

Query Params

pageSize

number

≥ 0

This parameter sets the maximum number of responses to be displayed per page. If the page size is insufficient to accommodate the whole number of responses obtained, the pagination object will include a link to the next page as well as the next page token. If left blank, it defaults to 100.

pageToken

string

Use this parameter to specify the pageToken of a page to which you want to navigate. This pageToken can be obtained from a previous request which specified a limit and will only be active for 15 minutes after it is created.

includeFields

array of strings

This query parameter allows you to specify which field properties should be returned in the response body by selecting from the drop down. To get the relevant field properties, use comma separated values. If this field is left blank, the default properties are returned.

includeFields

Allowed:

includeAllFields

boolean

This query parameter allows you to specify if all the field properties should be returned in the response body. If the field is left blank, the default field properties are returned.

sortBy

string

enum

You can use the sortBy param to sort the responses by the given field.

Allowed:

sortOrder

string

enum

The sortOrder param can be used to specify the sorting order, which can be Ascending (ASC) or Descending (DESC). Descending is the default option.

Allowed:

match

string

enum

You can use the match param to specify if we need to filter the entries using either AND(all) / OR(any). Defaults to AND.

Allowed:

createdAt.gt

int64

You can use this param to provide an epoch milli value and the responses will contain fields whose date are greater than the given fields created date.

createdAt.eq

int64

You can use this param to provide an epoch milli value and the responses will contain exact matches of fields that match the given fields created date.

createdAt.lt

int64

You can use this param to provide an epoch milli value and the responses will contain fields whose date are less than the given fields created date.

createdAt.ge

int64

You can use this param to provide an epoch milli value and the responses will contain fields whose date are greater than or equal to the given fields created date.

createdAt.le

int64

You can use this param to provide an epoch milli value and the responses will contain fields whose date are less than or equal to the given fields created date.

updatedAt.gt

int64

You can use this param to provide an epoch milli value and the responses will contain fields whose date are greater than the given fields updated date.

updatedAt.eq

int64

You can use this param to provide an epoch milli value and the responses will contain exact matches of fields that match the given fields updated date.

updatedAt.lt

int64

You can use this param to provide an epoch milli value and the responses will contain fields whose date are less than the given fields updated date.

updatedAt.ge

int64

You can use this param to provide an epoch milli value and the responses will contain fields whose date are greater than or equal to the given fields updated date.

updatedAt.le

int64

You can use this param to provide an epoch milli value and the responses will contain fields whose date are less than or equal to the given fields updated date.

objectType.eq

string

enum

You can use this param to specify a object type for the fields and the responses will contain exact matches of fields that have the given object type.

Allowed:

fieldType.eq

string

enum

You can use this param to specify a field type for the fields and the responses will contain exact matches of fields that have the given field type.

enabled.eq

boolean

You can use this parameter to specify whether responses will contains the enabled or disabled fields.

private.eq

boolean

You can use this parameter to specify whether responses will contains the private or shared fields.

Responses

200The requested action was successfully executed.

400This error typically happens when the request payload contains an error. If you want to make sure that the request's parameters are named correctly and are the right data types, you can examine the request's syntax.

401You see this error when trying to access this resource without being authenticated. Check the API request header to make sure it is not empty and has a valid api-key that you acquired from the Rocketlane API Settings tab.