`approval-requests`

5 operations. Shapes are sketches of the declared schemas, bounded in depth — the authoritative document is linked from the index.

GET`/orgs/{orgSlug}/approval-requests`

Requires bearerAuth

Parameters

Parameters for GET /orgs/{orgSlug}/approval-requests
Name	In	Type	Notes
`orgSlug`required	path	`string`	min length 1
`status`	query	`"PENDING" \| "APPROVED" \| "REJECTED" \| "EXPIRED"`	one of "PENDING" \| "APPROVED" \| "REJECTED" \| "EXPIRED"
`limit`	query	`integer`	default 50, min 1, max 100

Response 200

{
  data: {
    id: string
    orgId: string
    requesterPrincipalId: string
    onBehalfOfPrincipalId: string | null
    action: string
    riskClass: string
    targetType: string
    targetId: string
    status: "PENDING" | "APPROVED" | "REJECTED" | "EXPIRED"
    minApprovers: integer
    policyId: string | null
    deciderPrincipalId: string | null
    decidedAt: string | null
    reason: string | null
    expiresAt: string
    createdAt: string
    payload: unknown | null
  }[]
}

Response 400 · `bad_request` — the path, query or body failed validation. `details` carries the Zod issues, one per offending field.

{
  error: {
    code: "bad_request" | "conflict" | "forbidden" | "internal_error" | "mfa_required" | "not_found" | "payload_too_large" | "quota_exceeded" | … 6 more
    message: string
    details?: unknown
    requestId?: string
  }
}

Response 401 · `unauthorized` — no credential, or one that is expired, revoked or not valid for this resource. `mfa_required` when the credential is good but a second factor is owed.

{
  error: {
    code: "bad_request" | "conflict" | "forbidden" | "internal_error" | "mfa_required" | "not_found" | "payload_too_large" | "quota_exceeded" | … 6 more
    message: string
    details?: unknown
    requestId?: string
  }
}

Response 403 · `forbidden` — the credential is valid and its scopes or this principal’s membership do not reach this resource. Scopes are re-intersected with live memberships on every request, so this can appear for a token that worked yesterday.

{
  error: {
    code: "bad_request" | "conflict" | "forbidden" | "internal_error" | "mfa_required" | "not_found" | "payload_too_large" | "quota_exceeded" | … 6 more
    message: string
    details?: unknown
    requestId?: string
  }
}

Response 404 · `not_found` — no such resource, OR one this principal cannot see. The two are deliberately one answer: a 403 would confirm the existence of something whose identifier is guessable.

{
  error: {
    code: "bad_request" | "conflict" | "forbidden" | "internal_error" | "mfa_required" | "not_found" | "payload_too_large" | "quota_exceeded" | … 6 more
    message: string
    details?: unknown
    requestId?: string
  }
}

Response 429 · `rate_limited` or `quota_exceeded` — over a ceiling. `Retry-After` says when to come back, and `x-ratelimit-limit` / `-remaining` / `-reset` describe the bucket.

{
  error: {
    code: "bad_request" | "conflict" | "forbidden" | "internal_error" | "mfa_required" | "not_found" | "payload_too_large" | "quota_exceeded" | … 6 more
    message: string
    details?: unknown
    requestId?: string
  }
}

Response 500 · `internal_error` — an unhandled failure on this side. The message is always generic; `requestId` is the part worth quoting.

{
  error: {
    code: "bad_request" | "conflict" | "forbidden" | "internal_error" | "mfa_required" | "not_found" | "payload_too_large" | "quota_exceeded" | … 6 more
    message: string
    details?: unknown
    requestId?: string
  }
}

Request

curl https://api.bucker.io/orgs/{orgSlug}/approval-requests \
  -H 'authorization: Bearer $BUCKER_TOKEN'

POST`/orgs/{orgSlug}/approval-requests`

Requires bearerAuth

Parameters

Parameters for POST /orgs/{orgSlug}/approval-requests
Name	In	Type	Notes
`orgSlug`required	path	`string`	min length 1

Request body (required) · `application/json`

{
  action: string
  targetType: string
  targetId: string
  projectTag?: string | null
  summary?: string | null
  ttlMinutes?: integer
  channelIds?: string[]
  notify?: boolean
}

Response 200

{
  decision: "ALLOW" | "ASK" | "DENY"
  riskClass: string
  reason: string
  minApprovers: integer
  policySource: string
  request: {
    id: string
    orgId: string
    requesterPrincipalId: string
    onBehalfOfPrincipalId: string | null
    action: string
    riskClass: string
    targetType: string
    targetId: string
    status: "PENDING" | "APPROVED" | "REJECTED" | "EXPIRED"
    minApprovers: integer
    policyId: string | null
    deciderPrincipalId: string | null
    decidedAt: string | null
    reason: string | null
    expiresAt: string
    createdAt: string
    payload: unknown | null
  } | null
  deliveries: {
    channelId: string | null
    kind: string
    delivered: boolean
    error: string | null
  }[]
}

Response 201

{
  decision: "ALLOW" | "ASK" | "DENY"
  riskClass: string
  reason: string
  minApprovers: integer
  policySource: string
  request: {
    id: string
    orgId: string
    requesterPrincipalId: string
    onBehalfOfPrincipalId: string | null
    action: string
    riskClass: string
    targetType: string
    targetId: string
    status: "PENDING" | "APPROVED" | "REJECTED" | "EXPIRED"
    minApprovers: integer
    policyId: string | null
    deciderPrincipalId: string | null
    decidedAt: string | null
    reason: string | null
    expiresAt: string
    createdAt: string
    payload: unknown | null
  } | null
  deliveries: {
    channelId: string | null
    kind: string
    delivered: boolean
    error: string | null
  }[]
}

Response 400 · `bad_request` — the path, query or body failed validation. `details` carries the Zod issues, one per offending field.

{
  error: {
    code: "bad_request" | "conflict" | "forbidden" | "internal_error" | "mfa_required" | "not_found" | "payload_too_large" | "quota_exceeded" | … 6 more
    message: string
    details?: unknown
    requestId?: string
  }
}

Response 401 · `unauthorized` — no credential, or one that is expired, revoked or not valid for this resource. `mfa_required` when the credential is good but a second factor is owed.

{
  error: {
    code: "bad_request" | "conflict" | "forbidden" | "internal_error" | "mfa_required" | "not_found" | "payload_too_large" | "quota_exceeded" | … 6 more
    message: string
    details?: unknown
    requestId?: string
  }
}

Response 403 · `forbidden` — the credential is valid and its scopes or this principal’s membership do not reach this resource. Scopes are re-intersected with live memberships on every request, so this can appear for a token that worked yesterday.

{
  error: {
    code: "bad_request" | "conflict" | "forbidden" | "internal_error" | "mfa_required" | "not_found" | "payload_too_large" | "quota_exceeded" | … 6 more
    message: string
    details?: unknown
    requestId?: string
  }
}

Response 404 · `not_found` — no such resource, OR one this principal cannot see. The two are deliberately one answer: a 403 would confirm the existence of something whose identifier is guessable.

{
  error: {
    code: "bad_request" | "conflict" | "forbidden" | "internal_error" | "mfa_required" | "not_found" | "payload_too_large" | "quota_exceeded" | … 6 more
    message: string
    details?: unknown
    requestId?: string
  }
}

Response 429 · `rate_limited` or `quota_exceeded` — over a ceiling. `Retry-After` says when to come back, and `x-ratelimit-limit` / `-remaining` / `-reset` describe the bucket.

{
  error: {
    code: "bad_request" | "conflict" | "forbidden" | "internal_error" | "mfa_required" | "not_found" | "payload_too_large" | "quota_exceeded" | … 6 more
    message: string
    details?: unknown
    requestId?: string
  }
}

Response 500 · `internal_error` — an unhandled failure on this side. The message is always generic; `requestId` is the part worth quoting.

{
  error: {
    code: "bad_request" | "conflict" | "forbidden" | "internal_error" | "mfa_required" | "not_found" | "payload_too_large" | "quota_exceeded" | … 6 more
    message: string
    details?: unknown
    requestId?: string
  }
}

Request

curl -X POST https://api.bucker.io/orgs/{orgSlug}/approval-requests \
  -H 'authorization: Bearer $BUCKER_TOKEN' \
  -H 'content-type: application/json' \
  -d '{ … }'

GET`/orgs/{orgSlug}/approval-requests/{requestId}`

Requires bearerAuth

Parameters

Parameters for GET /orgs/{orgSlug}/approval-requests/{requestId}
Name	In	Type	Notes
`orgSlug`required	path	`string`	min length 1
`requestId`required	path	`string`	min length 1

Response 200

{
  id: string
  orgId: string
  requesterPrincipalId: string
  onBehalfOfPrincipalId: string | null
  action: string
  riskClass: string
  targetType: string
  targetId: string
  status: "PENDING" | "APPROVED" | "REJECTED" | "EXPIRED"
  minApprovers: integer
  policyId: string | null
  deciderPrincipalId: string | null
  decidedAt: string | null
  reason: string | null
  expiresAt: string
  createdAt: string
  payload: unknown | null
}

Response 400 · `bad_request` — the path, query or body failed validation. `details` carries the Zod issues, one per offending field.

{
  error: {
    code: "bad_request" | "conflict" | "forbidden" | "internal_error" | "mfa_required" | "not_found" | "payload_too_large" | "quota_exceeded" | … 6 more
    message: string
    details?: unknown
    requestId?: string
  }
}

Response 401 · `unauthorized` — no credential, or one that is expired, revoked or not valid for this resource. `mfa_required` when the credential is good but a second factor is owed.

{
  error: {
    code: "bad_request" | "conflict" | "forbidden" | "internal_error" | "mfa_required" | "not_found" | "payload_too_large" | "quota_exceeded" | … 6 more
    message: string
    details?: unknown
    requestId?: string
  }
}

Response 403 · `forbidden` — the credential is valid and its scopes or this principal’s membership do not reach this resource. Scopes are re-intersected with live memberships on every request, so this can appear for a token that worked yesterday.

{
  error: {
    code: "bad_request" | "conflict" | "forbidden" | "internal_error" | "mfa_required" | "not_found" | "payload_too_large" | "quota_exceeded" | … 6 more
    message: string
    details?: unknown
    requestId?: string
  }
}

Response 404 · `not_found` — no such resource, OR one this principal cannot see. The two are deliberately one answer: a 403 would confirm the existence of something whose identifier is guessable.

{
  error: {
    code: "bad_request" | "conflict" | "forbidden" | "internal_error" | "mfa_required" | "not_found" | "payload_too_large" | "quota_exceeded" | … 6 more
    message: string
    details?: unknown
    requestId?: string
  }
}

Response 429 · `rate_limited` or `quota_exceeded` — over a ceiling. `Retry-After` says when to come back, and `x-ratelimit-limit` / `-remaining` / `-reset` describe the bucket.

{
  error: {
    code: "bad_request" | "conflict" | "forbidden" | "internal_error" | "mfa_required" | "not_found" | "payload_too_large" | "quota_exceeded" | … 6 more
    message: string
    details?: unknown
    requestId?: string
  }
}

Response 500 · `internal_error` — an unhandled failure on this side. The message is always generic; `requestId` is the part worth quoting.

{
  error: {
    code: "bad_request" | "conflict" | "forbidden" | "internal_error" | "mfa_required" | "not_found" | "payload_too_large" | "quota_exceeded" | … 6 more
    message: string
    details?: unknown
    requestId?: string
  }
}

Request

curl https://api.bucker.io/orgs/{orgSlug}/approval-requests/{requestId} \
  -H 'authorization: Bearer $BUCKER_TOKEN'

POST`/orgs/{orgSlug}/approval-requests/{requestId}/approve`

Requires bearerAuth

Parameters

Parameters for POST /orgs/{orgSlug}/approval-requests/{requestId}/approve
Name	In	Type	Notes
`orgSlug`required	path	`string`	min length 1
`requestId`required	path	`string`	min length 1

Request body (required) · `application/json`

{
  reason?: string
} | null

Response 200

{
  request: {
    id: string
    orgId: string
    requesterPrincipalId: string
    onBehalfOfPrincipalId: string | null
    action: string
    riskClass: string
    targetType: string
    targetId: string
    status: "PENDING" | "APPROVED" | "REJECTED" | "EXPIRED"
    minApprovers: integer
    policyId: string | null
    deciderPrincipalId: string | null
    decidedAt: string | null
    reason: string | null
    expiresAt: string
    createdAt: string
    payload: unknown | null
  }
  approvals: integer
  remaining: integer
  hasIndependentApprover: boolean
  idempotent: boolean
}

Response 400 · `bad_request` — the path, query or body failed validation. `details` carries the Zod issues, one per offending field.

{
  error: {
    code: "bad_request" | "conflict" | "forbidden" | "internal_error" | "mfa_required" | "not_found" | "payload_too_large" | "quota_exceeded" | … 6 more
    message: string
    details?: unknown
    requestId?: string
  }
}

Response 401 · `unauthorized` — no credential, or one that is expired, revoked or not valid for this resource. `mfa_required` when the credential is good but a second factor is owed.

{
  error: {
    code: "bad_request" | "conflict" | "forbidden" | "internal_error" | "mfa_required" | "not_found" | "payload_too_large" | "quota_exceeded" | … 6 more
    message: string
    details?: unknown
    requestId?: string
  }
}

Response 403 · `forbidden` — the credential is valid and its scopes or this principal’s membership do not reach this resource. Scopes are re-intersected with live memberships on every request, so this can appear for a token that worked yesterday.

{
  error: {
    code: "bad_request" | "conflict" | "forbidden" | "internal_error" | "mfa_required" | "not_found" | "payload_too_large" | "quota_exceeded" | … 6 more
    message: string
    details?: unknown
    requestId?: string
  }
}

Response 404 · `not_found` — no such resource, OR one this principal cannot see. The two are deliberately one answer: a 403 would confirm the existence of something whose identifier is guessable.

{
  error: {
    code: "bad_request" | "conflict" | "forbidden" | "internal_error" | "mfa_required" | "not_found" | "payload_too_large" | "quota_exceeded" | … 6 more
    message: string
    details?: unknown
    requestId?: string
  }
}

Response 429 · `rate_limited` or `quota_exceeded` — over a ceiling. `Retry-After` says when to come back, and `x-ratelimit-limit` / `-remaining` / `-reset` describe the bucket.

{
  error: {
    code: "bad_request" | "conflict" | "forbidden" | "internal_error" | "mfa_required" | "not_found" | "payload_too_large" | "quota_exceeded" | … 6 more
    message: string
    details?: unknown
    requestId?: string
  }
}

Response 500 · `internal_error` — an unhandled failure on this side. The message is always generic; `requestId` is the part worth quoting.

{
  error: {
    code: "bad_request" | "conflict" | "forbidden" | "internal_error" | "mfa_required" | "not_found" | "payload_too_large" | "quota_exceeded" | … 6 more
    message: string
    details?: unknown
    requestId?: string
  }
}

Request

curl -X POST https://api.bucker.io/orgs/{orgSlug}/approval-requests/{requestId}/approve \
  -H 'authorization: Bearer $BUCKER_TOKEN' \
  -H 'content-type: application/json' \
  -d '{ … }'

POST`/orgs/{orgSlug}/approval-requests/{requestId}/reject`

Requires bearerAuth

Parameters

Parameters for POST /orgs/{orgSlug}/approval-requests/{requestId}/reject
Name	In	Type	Notes
`orgSlug`required	path	`string`	min length 1
`requestId`required	path	`string`	min length 1

Request body (required) · `application/json`

{
  reason: string
}

Response 200

{
  request: {
    id: string
    orgId: string
    requesterPrincipalId: string
    onBehalfOfPrincipalId: string | null
    action: string
    riskClass: string
    targetType: string
    targetId: string
    status: "PENDING" | "APPROVED" | "REJECTED" | "EXPIRED"
    minApprovers: integer
    policyId: string | null
    deciderPrincipalId: string | null
    decidedAt: string | null
    reason: string | null
    expiresAt: string
    createdAt: string
    payload: unknown | null
  }
  approvals: integer
  remaining: integer
  hasIndependentApprover: boolean
  idempotent: boolean
}

Response 400 · `bad_request` — the path, query or body failed validation. `details` carries the Zod issues, one per offending field.

{
  error: {
    code: "bad_request" | "conflict" | "forbidden" | "internal_error" | "mfa_required" | "not_found" | "payload_too_large" | "quota_exceeded" | … 6 more
    message: string
    details?: unknown
    requestId?: string
  }
}

Response 401 · `unauthorized` — no credential, or one that is expired, revoked or not valid for this resource. `mfa_required` when the credential is good but a second factor is owed.

{
  error: {
    code: "bad_request" | "conflict" | "forbidden" | "internal_error" | "mfa_required" | "not_found" | "payload_too_large" | "quota_exceeded" | … 6 more
    message: string
    details?: unknown
    requestId?: string
  }
}

Response 403 · `forbidden` — the credential is valid and its scopes or this principal’s membership do not reach this resource. Scopes are re-intersected with live memberships on every request, so this can appear for a token that worked yesterday.

{
  error: {
    code: "bad_request" | "conflict" | "forbidden" | "internal_error" | "mfa_required" | "not_found" | "payload_too_large" | "quota_exceeded" | … 6 more
    message: string
    details?: unknown
    requestId?: string
  }
}

Response 404 · `not_found` — no such resource, OR one this principal cannot see. The two are deliberately one answer: a 403 would confirm the existence of something whose identifier is guessable.

{
  error: {
    code: "bad_request" | "conflict" | "forbidden" | "internal_error" | "mfa_required" | "not_found" | "payload_too_large" | "quota_exceeded" | … 6 more
    message: string
    details?: unknown
    requestId?: string
  }
}

Response 429 · `rate_limited` or `quota_exceeded` — over a ceiling. `Retry-After` says when to come back, and `x-ratelimit-limit` / `-remaining` / `-reset` describe the bucket.

{
  error: {
    code: "bad_request" | "conflict" | "forbidden" | "internal_error" | "mfa_required" | "not_found" | "payload_too_large" | "quota_exceeded" | … 6 more
    message: string
    details?: unknown
    requestId?: string
  }
}

Response 500 · `internal_error` — an unhandled failure on this side. The message is always generic; `requestId` is the part worth quoting.

{
  error: {
    code: "bad_request" | "conflict" | "forbidden" | "internal_error" | "mfa_required" | "not_found" | "payload_too_large" | "quota_exceeded" | … 6 more
    message: string
    details?: unknown
    requestId?: string
  }
}

Request

curl -X POST https://api.bucker.io/orgs/{orgSlug}/approval-requests/{requestId}/reject \
  -H 'authorization: Bearer $BUCKER_TOKEN' \
  -H 'content-type: application/json' \
  -d '{ … }'

approval-requests

GET/orgs/{orgSlug}/approval-requests

Parameters

Response 200

Response 400 · `bad_request` — the path, query or body failed validation. `details` carries the Zod issues, one per offending field.

Response 401 · `unauthorized` — no credential, or one that is expired, revoked or not valid for this resource. `mfa_required` when the credential is good but a second factor is owed.

Response 403 · `forbidden` — the credential is valid and its scopes or this principal’s membership do not reach this resource. Scopes are re-intersected with live memberships on every request, so this can appear for a token that worked yesterday.

Response 404 · `not_found` — no such resource, OR one this principal cannot see. The two are deliberately one answer: a 403 would confirm the existence of something whose identifier is guessable.

Response 429 · `rate_limited` or `quota_exceeded` — over a ceiling. `Retry-After` says when to come back, and `x-ratelimit-limit` / `-remaining` / `-reset` describe the bucket.

Response 500 · `internal_error` — an unhandled failure on this side. The message is always generic; `requestId` is the part worth quoting.

Request

POST/orgs/{orgSlug}/approval-requests

Parameters

Request body (required) · application/json

Response 200

Response 201

Response 400 · `bad_request` — the path, query or body failed validation. `details` carries the Zod issues, one per offending field.

Response 401 · `unauthorized` — no credential, or one that is expired, revoked or not valid for this resource. `mfa_required` when the credential is good but a second factor is owed.

Response 403 · `forbidden` — the credential is valid and its scopes or this principal’s membership do not reach this resource. Scopes are re-intersected with live memberships on every request, so this can appear for a token that worked yesterday.

Response 404 · `not_found` — no such resource, OR one this principal cannot see. The two are deliberately one answer: a 403 would confirm the existence of something whose identifier is guessable.

Response 429 · `rate_limited` or `quota_exceeded` — over a ceiling. `Retry-After` says when to come back, and `x-ratelimit-limit` / `-remaining` / `-reset` describe the bucket.

Response 500 · `internal_error` — an unhandled failure on this side. The message is always generic; `requestId` is the part worth quoting.

Request

GET/orgs/{orgSlug}/approval-requests/{requestId}

Parameters

Response 200

Response 400 · `bad_request` — the path, query or body failed validation. `details` carries the Zod issues, one per offending field.

Response 401 · `unauthorized` — no credential, or one that is expired, revoked or not valid for this resource. `mfa_required` when the credential is good but a second factor is owed.

Response 403 · `forbidden` — the credential is valid and its scopes or this principal’s membership do not reach this resource. Scopes are re-intersected with live memberships on every request, so this can appear for a token that worked yesterday.

Response 404 · `not_found` — no such resource, OR one this principal cannot see. The two are deliberately one answer: a 403 would confirm the existence of something whose identifier is guessable.

Response 429 · `rate_limited` or `quota_exceeded` — over a ceiling. `Retry-After` says when to come back, and `x-ratelimit-limit` / `-remaining` / `-reset` describe the bucket.

Response 500 · `internal_error` — an unhandled failure on this side. The message is always generic; `requestId` is the part worth quoting.

Request

POST/orgs/{orgSlug}/approval-requests/{requestId}/approve

Parameters

Request body (required) · application/json

Response 200

Response 400 · `bad_request` — the path, query or body failed validation. `details` carries the Zod issues, one per offending field.

Response 401 · `unauthorized` — no credential, or one that is expired, revoked or not valid for this resource. `mfa_required` when the credential is good but a second factor is owed.

Response 403 · `forbidden` — the credential is valid and its scopes or this principal’s membership do not reach this resource. Scopes are re-intersected with live memberships on every request, so this can appear for a token that worked yesterday.

Response 404 · `not_found` — no such resource, OR one this principal cannot see. The two are deliberately one answer: a 403 would confirm the existence of something whose identifier is guessable.

Response 429 · `rate_limited` or `quota_exceeded` — over a ceiling. `Retry-After` says when to come back, and `x-ratelimit-limit` / `-remaining` / `-reset` describe the bucket.

Response 500 · `internal_error` — an unhandled failure on this side. The message is always generic; `requestId` is the part worth quoting.

Request

POST/orgs/{orgSlug}/approval-requests/{requestId}/reject

Parameters

Request body (required) · application/json

Response 200

Response 400 · `bad_request` — the path, query or body failed validation. `details` carries the Zod issues, one per offending field.

Response 401 · `unauthorized` — no credential, or one that is expired, revoked or not valid for this resource. `mfa_required` when the credential is good but a second factor is owed.

Response 403 · `forbidden` — the credential is valid and its scopes or this principal’s membership do not reach this resource. Scopes are re-intersected with live memberships on every request, so this can appear for a token that worked yesterday.

Response 404 · `not_found` — no such resource, OR one this principal cannot see. The two are deliberately one answer: a 403 would confirm the existence of something whose identifier is guessable.

Response 429 · `rate_limited` or `quota_exceeded` — over a ceiling. `Retry-After` says when to come back, and `x-ratelimit-limit` / `-remaining` / `-reset` describe the bucket.

Response 500 · `internal_error` — an unhandled failure on this side. The message is always generic; `requestId` is the part worth quoting.

Request

`approval-requests`

GET`/orgs/{orgSlug}/approval-requests`

POST`/orgs/{orgSlug}/approval-requests`

Request body (required) · `application/json`

GET`/orgs/{orgSlug}/approval-requests/{requestId}`

POST`/orgs/{orgSlug}/approval-requests/{requestId}/approve`

Request body (required) · `application/json`

POST`/orgs/{orgSlug}/approval-requests/{requestId}/reject`

Request body (required) · `application/json`