Skip to main content
GET
cURL

Authorizations

Authorization
string
header
required

API key or UI session JWT passed as a Bearer token.

Headers

AiQL-Workspace
string
required

ID of the workspace the request operates on.

Path Parameters

id
string
required

Response

Successful Response

id
string
required

Unique identifier of the request.

title
string
required

Title of the request.

description
string | null
required

Description of the request.

status
string
required

Current status of the request.

created_at
string<date-time>
required

Timestamp when the request was created.

updated_at
string<date-time>
required

Timestamp when the request was last updated.

labels
string[]

Labels attached to the request.

author
UserRef · object | null

Author of the request.

assignees
UserRef · object[]

Users assigned to the request.

opened_at
string<date-time> | null

Timestamp when the request was opened.

changes_requested_at
string<date-time> | null

Timestamp when changes were last requested on the request.

approved_at
string<date-time> | null

Timestamp when the request was approved.

rejected_at
string<date-time> | null

Timestamp when the request was rejected.

approval_count
integer
default:0

Number of reviews in APPROVED status.

required_approvals
integer
default:0

Number of reviews if any exist, otherwise the number of assignees.

comment_count
integer
default:0

Number of comments across all reviews.

changes
ChangeResponse · object[]

Changes included in the request.

reviews
ReviewResponse · object[]

Reviews of the request.