List releases (GraphQL)

releases(projectReference: String!, limit: Int, cursor: String, sortBy: ReleaseSortField, sortOrder: ReleaseSortOrder): ReleasePage!

Requires project.releases.read.

Arguments

ArgumentTypeRequiredDescription
projectReferenceString!YesProject UUID, slug or configured domain.
limitIntNoReleases per page, between 1 and 100. Defaults to 20.
cursorStringNopageInfo.endCursor of the previous page, read with the same sortBy and sortOrder.
sortByReleaseSortFieldNoSort field. Defaults to created_at. Releases with the same value are ordered by ID ascending.
sortOrderReleaseSortOrderNoSort order. Defaults to desc.

Response

Returns ReleasePage!. Open the type for its fields and nested types.

FieldTypeDescription
data[Release!]!Releases of this page.
pageInfoPageInfo!Continue from endCursor while hasNextPage is true.

Types marked with ! cannot be null. Lists use [Type] notation. The type index lists all published input and response types.

Example

graphql
query Releases($projectReference: String!, $limit: Int, $cursor: String, $sortBy: ReleaseSortField, $sortOrder: ReleaseSortOrder) {
  releases(projectReference: $projectReference, limit: $limit, cursor: $cursor, sortBy: $sortBy, sortOrder: $sortOrder) {
    data {
      id
      projectId
      name
      createdAt
      updatedAt
    }
    pageInfo {
      hasNextPage
      endCursor
      hasPreviousPage
      startCursor
    }
  }
}
json
{
  "projectReference": "00000000-0000-4000-8000-000000000001"
}