Sign in

v1

latestOpenAPI 3.0.12026-07-2464217456.8 KB
Fields

Get all fields

get/1.0/fields

Query parameters

pageSizenumber
Example:100

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.

pageTokenstring
Example:59c12a42-dd10-11ed-afa1-0242ac120002

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.

includeFieldsstring[]

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.

includeAllFieldsboolean
Example:true

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'fieldLabel'

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

sortOrder'ASC' | 'DESC'

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

match'all' | 'any'

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

createdAt.gtinteger
Example:1625164800000

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.eqinteger
Example:1625164800000

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.ltinteger
Example:1625164800000

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.geinteger
Example:1625164800000

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.leinteger
Example:1625164800000

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.gtinteger
Example:1625164800000

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.eqinteger
Example:1625164800000

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.ltinteger
Example:1625164800000

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.geinteger
Example:1625164800000

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.leinteger
Example:1625164800000

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'PROJECT' | 'TASK' | 'USER'

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.

fieldType.eq'TEXT' | 'MULTI_LINE_TEXT' | 'YES_OR_NO' | 'DATE' | 'SINGLE_CHOICE' | 'MULTIPLE_CHOICE' | 'SINGLE_USER' | 'MULTIPLE_USER' | 'NUMBER' | 'NOTE' | 'RATING'

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.eqboolean
Example:true

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

private.eqboolean
Example:true

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

Response

The requested action was successfully executed.

Example response

{
  "data": [
    {
      "fieldId": 201,
      "fieldLabel": "MRR",
      "fieldDescription": "Priority of the bug.",
      "fieldType": "MULTI_LINE_TEXT",
      "objectType": "TASK",
      "fieldOptions": [
        {
          "optionValue": 2,
          "optionLabel": "Todo",
          "optionColor": "RED"
        }
      ],
      "ratingScale": "THREE",
      "createdBy": {
        "emailId": "john.doe@rocketlane.com",
        "userId": 201,
        "firstName": "John",
        "lastName": "Doe"
      },
      "updatedBy": {
        "emailId": "john.doe@rocketlane.com",
        "userId": 201,
        "firstName": "John",
        "lastName": "Doe"
      },
      "createdAt": 1681319726000,
      "updatedAt": 1681319726000
    }
  ],
  "pagination": {
    "pageSize": 100,
    "hasMore": true,
    "totalRecordCount": 10398,
    "nextPage": "https://api.rocketlane.com/api/1.0/fields?includeFields=category,minutes&billable.eq=false&sortBy=startDate&sortOrder=desc&pageToken=e4a3dd8e-e338-11ed-b5ea-0242ac120002&limit=100&assignee.any=1&startDate.gt=2022-01-02",
    "nextPageToken": "e4a3dd8e-e338-11ed-b5ea-0242ac120002"
  }
}