provider Issue fields GET /rest/api/3/field/search
@utdk/jira /rest/api/3/field/search
Get fields paginated
Returns a [paginated](#pagination) list of fields for Classic Jira projects. The list can include: * all fields * specific fields, by defining `id` * fields that contain a string in the field name or description, by defining `query` * specific fields that contain a string in the field name or description, by defining `id` and `query` Use `type` must be set to `custom` to show custom fields only. **[Permissions](#permissions) required:** Permission to access Jira.
startAt query
The index of the first item to return in a page of results (page offset).
integer
maxResults query
The maximum number of items to return per page.
integer
type query
The type of fields to search.
array
id query
The IDs of the custom fields to return or, where `query` is specified, filter.
array
query query
String used to perform a case-insensitive partial match with field names or descriptions.
string
orderBy query
[Order](#ordering) the results by: * `contextsCount` sorts by the number of contexts related to a field * `lastUsed` sorts by the date when the value of the field last changed * `name` sorts by the field name * `screensCount` sorts by the number of screens related to a field
enum: contextsCount, -contextsCount, +contextsCount, lastUsed…
expand query
Use [expand](#expansion) to include additional information in the response. This parameter accepts a comma-separated list. Expand options include: * `key` returns the key for each field * `stableId` returns the stableId for each field * `lastUsed` returns the date when the value of the field last changed * `screensCount` returns the number of screens related to a field * `contextsCount` returns the number of contexts related to a field * `isLocked` returns information about whether the field is locked * `searcherKey` returns the searcher key for each custom field
string
projectIds query
The IDs of the projects to filter the fields by. Fields belonging to project Ids that the user does not have access to will not be returned
array

Try it

Authentication
Configure credentials for The Jira Cloud platform REST API
Gateway
The gateway proxies requests and injects credentials server-side. Configure credentials above, then enter your gateway URL.

Saved automatically to browser storage.

getfieldspaginated
GET/rest/api/3/field/search
Returns a [paginated](#pagination) list of fields for Classic Jira projects. The list can include: * all fields * specific fields, by defining `id` * fields that contain a string in the field name or description, by defining `query` * specific fields that contain a string in the field name or description, by defining `id` and `query` Use `type` must be set to `custom` to show custom fields only. **[Permissions](#permissions) required:** Permission to access Jira.

The index of the first item to return in a page of results (page offset).

The maximum number of items to return per page.

The type of fields to search.

The IDs of the custom fields to return or, where `query` is specified, filter.

String used to perform a case-insensitive partial match with field names or descriptions.

[Order](#ordering) the results by: * `contextsCount` sorts by the number of contexts related to a field * `lastUsed` sorts by the date when the value of the field last changed * `name` sorts by the field name * `screensCount` sorts by the number of screens related to a field

Use [expand](#expansion) to include additional information in the response. This parameter accepts a comma-separated list. Expand options include: * `key` returns the key for each field * `stableId` returns the stableId for each field * `lastUsed` returns the date when the value of the field last changed * `screensCount` returns the number of screens related to a field * `contextsCount` returns the number of contexts related to a field * `isLocked` returns information about whether the field is locked * `searcherKey` returns the searcher key for each custom field

The IDs of the projects to filter the fields by. Fields belonging to project Ids that the user does not have access to will not be returned

Enter a gateway URL above to enable sending.

Code snippet
Updates live as you fill in the form above.

TypeScript

import jira from '@utdk/jira';

await jira.getfieldspaginated({
  "startAt": 0,
  "maxResults": 50
})