Skip to main content
GET
List workspace approvals

Authorizations

Authorization
string
header
required

API key authentication. Generate an API key from your workspace settings.

Query Parameters

limit
integer
default:20

Maximum number of approvals to return (1-100)

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

Pagination cursor from the previous response's nextCursor. Format is timestampMs:approvalId. When paginating, pass the same sortBy and sortOrder as the initial request.

sortBy
enum<string>
default:createdAt

Field to sort results by. Use updatedAt for incremental sync so newly-updated approvals stream in order.

Available options:
createdAt,
updatedAt
sortOrder
enum<string>
default:desc

Sort order. Use asc with sortBy=updatedAt for incremental sync.

Available options:
asc,
desc
updatedAtMin
string<date-time>

Return approvals updated at or after this time. Pair with sortBy=updatedAt and sortOrder=asc for incremental sync from a saved checkpoint.

updatedAtMax
string<date-time>

Return approvals updated at or before this time.

createdAtMin
string<date-time>

Return approvals created at or after this time.

createdAtMax
string<date-time>

Return approvals created at or before this time.

statuses
enum<string>[]

Filter by approval statuses. Repeat the parameter to match any of multiple values.

Available options:
Requested,
Approved
postIds
string<uuid>[]

Filter by post IDs. Repeat the parameter to match any of multiple values.

approverIds
string<uuid>[]

Filter by approver user IDs. Repeat the parameter to match any of multiple values.

requestedByIds
string<uuid>[]

Filter by IDs of users who requested the approval. Repeat the parameter to match any of multiple values.

Response

Paginated list of workspace approvals

approvals
object[]
nextCursor
string | null

Cursor for the next page, or null when there are no more results

hasMore
boolean

Whether more approvals are available