GET /rest/api/2/field/{fieldId}/screens

Returns a paginated list of the screens a field is used in.

Permissions required: Administer Jira global permission.

Servers

Path parameters

Name Type Required Description
fieldId String Yes

The ID of the field to return screens for.

Query parameters

Name Type Required Description
startAt Integer No

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

Default value: 0

maxResults Integer No

The maximum number of items to return per page.

Default value: 100

expand String No

Use expand to include additional information about screens in the response. This parameter accepts tab which returns details about the screen tabs the field is used in.

How to start integrating

  1. Add HTTP Task to your workflow definition.
  2. Search for the API you want to integrate with and click on the name.
    • This loads the API reference documentation and prepares the Http request settings.
  3. Click Test request to test run your request to the API and see the API's response.