The Release Object

An object that represents a release. Learn more about the Releases app.

Properties

• name string

  Name of a release.

• id number

  Numeric ID of a release.

• release_at string

  Date to deploy the release (format: YYYY-mm-dd HH:MM).

• released boolean

  true when the release is published.

• uuid string

  Unique ID of the release.

• timezone string

  Time zone of the release.

• branches_to_deploy number[]

  An array of branch IDs (pipeline stages) to deploy with this release (requires the Pipelines app).

• created_at string

  Date and time the release was created (format: YYYY-mm-dd HH:MM).

• updated_at string

  Date and time the release was updated (format: YYYY-mm-dd HH:MM).

• owner_id number

  Numeric ID of the release owner.

• users_to_notify_ids string[]

  An array of IDs of users who should be notified about the release.

• public boolean

  Is the release accessible to all users in the space. The default value is true (public). When set to false, the release is restricted. Only the release or space owner can modify this field.

• allowed_user_ids number[]

  An array of IDs of users allowed to access and interact with the release. Only the release or space owner can modify this field.

• allowed_space_role_ids number[]

  An array of space role IDs allowed to access and interact with the release. Only the release or space owner can modify this field.

• allowed_api_key_ids number[]

  A release type access token assigned to the release. Only the release or space owner can modify this field.

Example Response

{
"release": {
  "name": "A Winter Special Release",
  "id": 123212,
  "release_at": null,
  "released": false,
  "uuid": "f4ea2f30-4645-4164-9826-3860215f0caq",
  "timezone": "Europe/Berlin",
  "branches_to_deploy": [
    32324
  ],
  "created_at": "2025-12-10T11:57:15.188Z",
  "updated_at": "2025-12-14T16:14:01.700Z",
  "owner_id": 444444,
  "users_to_notify_ids": [
    "444444"
  ],
  "public": false,
  "allowed_user_ids": [
    444444
  ],
  "allowed_space_role_ids": [
    12345678901234
  ],
  "allowed_api_key_ids": [
    0987654321
  ]
}
}