Policies

Get all policies

Changed on

Returns a paginated summary of all known policies, including their names, descriptions, and which projects each policy is assigned to.

When {@code tanuki-358-cursor-policy-listing} is enabled, omit cursor for the first page and pass the returned {@code nextPageCursor} for subsequent pages. The legacy {@code startAt} and {@code total} fields are null because an offset and total are not available in cursor mode. When disabled, the offset contract is unchanged.

get/rest/api/3/policies

Request

  • Base URL
    https://your-domain.atlassian.net
  • URL
    https://your-domain.atlassian.net/rest/api/3/policies
  • Auth
    • HTTP basic
    • or OAuth 2
      Authorization code: https://auth.atlassian.com/authorize
      Token URL: https://auth.atlassian.com/oauth/token scopes: manage:jira-configuration

Query parameters

startAtinteger

legacy 0-based offset (default 0); only 0 is accepted in cursor mode

maxResultsinteger

the maximum number of items to return per page (default 50; cursor max 50)

cursorstring

opaque cursor returned by the previous page, absent for the first page

Response

200 response

isLastboolean
maxResultsinteger
nextPageCursorstring
startAtinteger
totalinteger

Changes

  • f22db3da5febRevision changes
    • info

      added the new optional query request parameter cursor

    • info

      added the non-success response with the status

    • info

      added the non-success response with the status

    • info

      added the optional property to the response with the status

  • 0070598e9ea0Revision changes
    • info

      endpoint added