Skip to main content
GET
/
releases
List releases
curl --request GET \
  --url https://api.onset.io/v1/releases \
  --header 'Authorization: Bearer <token>'
[
  {
    "id": "<string>",
    "title": "<string>",
    "body": "<string>",
    "slug": "<string>",
    "status": "DRAFT",
    "version": "<string>",
    "is_pinned": true,
    "is_public": true,
    "is_pre_release": true,
    "hero": null,
    "changes": [
      {
        "id": "<string>",
        "change_id": "<string>",
        "content": "<string>"
      }
    ],
    "project": {
      "id": "<string>",
      "name": "<string>",
      "slug": "<string>"
    },
    "labels": [
      {
        "id": "<string>",
        "name": "<string>",
        "slug": "<string>",
        "color": "<string>"
      }
    ],
    "attachments": [
      {
        "type": "FILE",
        "content": {
          "title": "<string>",
          "url": "<string>",
          "size": 123,
          "type": "<string>"
        },
        "id": "<string>"
      }
    ],
    "contributors": [
      {
        "id": "<string>",
        "name": "<string>",
        "avatar_url": "<string>"
      }
    ],
    "released_at": "2023-11-07T05:31:56Z",
    "created_at": "2023-11-07T05:31:56Z",
    "updated_at": "2023-11-07T05:31:56Z"
  }
]

Authorizations

Authorization
string
header
required

Bearer authentication header of the form Bearer <token>, where <token> is your auth token.

Query Parameters

offset
integer
default:0

Number of items to skip

Required range: 0 <= x <= 1000
limit
integer
default:10

Maximum number of items to return

Required range: 1 <= x <= 100
slug
string

Filter by release slug

is_public
boolean

Filter by public visibility

status
enum<string>

Filter by release status

Available options:
DRAFT,
RELEASED
project_id
string

Filter by project ID

Response

List of releases retrieved successfully

id
string

Unique release identifier

title
string

Release title

body
string

Release description/body content (HTML formatted)

slug
string

URL-friendly release identifier

status
enum<string>

Current release status

Available options:
DRAFT,
RELEASED
version
string | null

Release version

is_pinned
boolean

Whether release is pinned

is_public
boolean

Whether release is publicly visible

is_pre_release
boolean

Whether this is a pre-release

hero
object | null

Hero image/video for the release

changes
object[]

List of changes in this release

project
object
labels
object[]
attachments
object[]
  • Option 1
  • Option 2
contributors
object[]

List of contributors to this release

released_at
string<date-time> | null

When the release was released

created_at
string<date-time>

When the release was created

updated_at
string<date-time>

When the release was last updated

I