Read release (GraphQL)

release(projectReference: String!, releaseReference: String!): Release!

Requires project.releases.read.

Arguments

ArgumentTypeRequiredDescription
projectReferenceString!YesProject UUID, slug or configured domain.
releaseReferenceString!YesRelease ID, latest, or a version specifier: 1.2.3 for exact, 1.2 for the newest 1.2.x, 1 for the newest 1.x.x.

Response

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

FieldTypeDescription
idID!
nameString
versionStringSemver version, for example 1.2.3. Null for releases created before versioning.
projectIdID
userIdIDAccount that created the release.
createdAtDateTimeRFC3339 creation timestamp.
updatedAtDateTimeRFC3339 timestamp of the last status or metadata change.
versions[Version!]!File versions captured by this release, hydrated from the linked version records.

All fields of Release.

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

Example

graphql
query Release($projectReference: String!, $releaseReference: String!) {
  release(projectReference: $projectReference, releaseReference: $releaseReference) {
    id
    projectId
    name
    createdAt
    updatedAt
  }
}
json
{
  "projectReference": "00000000-0000-4000-8000-000000000001",
  "releaseReference": "example"
}