Releases

List

List releases.

get/releases

Query parameters

offsetinteger

The offset of the items to return. An offset of 10 with a limit of 10 returns items 11-20.

limitinteger

Example:10

The maximum number of items to return. A limit of 15 with an offset of 0 returns items 1-15.

order_byReleaseOrderBy[]

Sort order for the release results.

[
  "created_at:desc"
]

expandReleaseListExpansion[]

Fields to expand on each release in the list.

[
  "config_schemas"
]

idstring[]

The release IDs to filter by.

[
  "rls_123"
]

versionstring[]

The release versions to filter by.

[
  "v1.0.0"
]

Response

Successfully listed the releases.

object'list' required

The object type, which is always list.

total_countinteger

The total number of items in the list. By default the total count is not returned. The total count must be expanded (using expand=total_count) to get the total number of items in the list.

limitinteger required

The maximum number of items to return. A limit of 15 with an offset of 0 returns items 1-15.

offsetinteger required

The offset of the items to return. An offset of 10 with a limit of 10 returns items 11-20.

has_moreboolean required

True if there are more items in the list to return. False if there are no more items to return.

Example response

{
  "object": "list",
  "data": [
    {
      "object": "release",
      "id": "rls_123",
      "version": "v1.0.0",
      "git_commit_id": "git_commit_123",
      "created_at": "2024-01-01T00:00:00Z",
      "updated_at": "2024-01-01T00:00:00Z"
    }
  ]
}

Changes

Changed in 2 of the 6 revisions of this API.4

Mar 6, 2026365853b9c33d2See the full diff
- ○
  added ConfigType to the allOf[subschema #2]/data/items/allOf[subschema #2]/config_schemas/items/allOf[subschema #2]/config_type response property allOf list for the response status 200
  response-property-all-of-added
- ○
  removed BaseConfigType from the allOf[subschema #2]/data/items/allOf[subschema #2]/config_schemas/items/allOf[subschema #2]/config_type response property allOf list for the response status 200
  response-property-all-of-removed
Mar 6, 20267f0f7fc868da2See the full diff
- ○
  added BaseConfigType to the allOf[subschema #2]/data/items/allOf[subschema #2]/config_schemas/items/allOf[subschema #2]/config_type response property allOf list for the response status 200
  response-property-all-of-added
- ○
  removed ConfigType from the allOf[subschema #2]/data/items/allOf[subschema #2]/config_schemas/items/allOf[subschema #2]/config_type response property allOf list for the response status 200
  response-property-all-of-removed
This revision also has 2 changes that name no endpoint, such as unreferenced schemas being removed. See the revision's changelog

Full history