---
title: "Get all fields"
method: GET
path: "/1.0/fields"
tags: ["Fields"]
---

# Get all fields

`GET /1.0/fields`

## Query parameters

- `pageSize` number
- `pageToken` string
- `includeFields` string[]
- `includeAllFields` boolean
- `sortBy` 'fieldLabel'
- `sortOrder` 'ASC' | 'DESC'
- `match` 'all' | 'any'
- `createdAt.gt` integer
- `createdAt.eq` integer
- `createdAt.lt` integer
- `createdAt.ge` integer
- `createdAt.le` integer
- `updatedAt.gt` integer
- `updatedAt.eq` integer
- `updatedAt.lt` integer
- `updatedAt.ge` integer
- `updatedAt.le` integer
- `objectType.eq` 'PROJECT' | 'TASK' | 'USER'
- `fieldType.eq` 'TEXT' | 'MULTI_LINE_TEXT' | 'YES_OR_NO' | 'DATE' | 'SINGLE_CHOICE' | 'MULTIPLE_CHOICE' | 'SINGLE_USER' | 'MULTIPLE_USER' | 'NUMBER' | 'NOTE' | 'RATING'
- `enabled.eq` boolean
- `private.eq` boolean

## Response `200`

The requested action was successfully executed.

- ExampleAPIResponseFields
  - `data` FieldModelPublicResponseForExample[] — Reflects all the default and custom fields and their values for the object searched, in an array format. If the includeFields param is utilised in the request body, it will return a customised response.
    - `fieldId` integer — The field's unique, system-generated identifier, which can be used to identify the field globally.
    - `fieldLabel` string — The fieldLabel is the name of the custom field
    - `fieldDescription` string — The description of the field
    - `fieldType` 'TEXT' | 'MULTI_LINE_TEXT' | 'YES_OR_NO' | 'DATE' | 'SINGLE_CHOICE' | 'MULTIPLE_CHOICE' | 'SINGLE_USER' | 'MULTIPLE_USER' | 'NUMBER' | 'NOTE' | 'RATING' — This defines type of the field. Refer [Custom Fields](https://developer.rocketlane.com/v1.0/docs/custom-fields) for further information
    - `objectType` string — This defines type of object that is associated with the field. This could be `TASK`, `PROJECT` or `USER`.
    - `fieldOptions` OptionsPublicAPIResponseEntity[] — The fieldOptions params define the value and label for the different options available for `SINGLE_CHOICE` and `MULTIPLE_CHOICE` fields.
      - `optionValue` integer — The optionValue is the unique identifier and is unique for each field.
      - `optionLabel` string — The optionLabel reflects the name of the options for the single or multiple choice field.
      - `optionColor` 'RED' | 'YELLOW' | 'GREEN' | 'TEAL' | 'CYAN' | 'BLUE' | 'PURPLE' | 'MAGENTA' | 'GRAY' | 'COOL_GRAY' — The optionColor reflects the color of the options for the single or multiple choice field.
    - `ratingScale` 'THREE' | 'FIVE' | 'SEVEN' | 'TEN' — The number of stars in the Rating Scale when Field Type is `RATING`.
    - `createdBy` FieldCreatedByUserPublicAPI — The team member who created the field.
      - `emailId` string — The team member's email identifier.
      - `userId` integer — The unique identifier for the team member.
      - `firstName` string — The first name of the team member.
      - `lastName` string — The last name of the team member.
    - `updatedBy` FieldUpdatedByUserPublicAPI — The team member who updated the field.
      - `emailId` string — The team member's email identifier.
      - `userId` integer — The unique identifier for the team member.
      - `firstName` string — The first name of the team member.
      - `lastName` string — The last name of the team member.
    - `createdAt` integer — The time when the field was created. The referenced time will be in epoch millis.
    - `updatedAt` integer — The time when the field was last updated. Any changes that's related to the field are captured and specified here in epoch millis.
    - `enabled` boolean — This depicts if the field is enabled or not. Only those fields which are enabled will reflect in the account.
    - `private` boolean — This depicts if the field is private or not.
  - `pagination` ExamplePaginationFields — Responses that return multiple objects will be paginated. The pagination params define how pages are structured and how to traverse through pages.
    - `pageSize` integer — Denotes the page size mentioned in the current request (limit). It defaults to 100 if left blank.
    - `hasMore` boolean — Tells us if there is more content.
    - `totalRecordCount` integer — Denotes the total resources matching the filters.
    - `nextPage` string — Denotes an API URL, which can be conveniently called to perform the subsequent search call to get to the next page.
    - `nextPageToken` string — Denotes a unique token that points to the next page of resources. To get results from subsequent pages, you can use the nextPageToken available in the response under pagination. This token is valid for 15 minutes.

## Other responses

- `400` — This 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.
- `401` — You 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.

---

[API](https://skmtc.net/rocketlane/apis/rocketlane-api.md) · [All operations](https://skmtc.net/rocketlane/apis/rocketlane-api/llms.txt) · [OpenAPI document](https://skmtc-service-staging.skmtc.workers.dev/v1/apis/rocketlane/rocketlane-api/revisions/1e8ba619e741/schema)