Approvals

List workspace approvals

Changed on

List all approval requests across the workspace in one paginated stream. Use for incremental sync by external integrations instead of polling each post individually. Supports keyset pagination and filters by status, post, approver, requester, and date range. Approvals on archived posts are included; filter client-side with post.archivedAt. Soft-deleted approvals are omitted from results.

get/approvals

Request

Query parameters

limitinteger

Maximum number of approvals to return (1-100)

cursorstring

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'createdAt' | 'updatedAt'

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

sortOrder'asc' | 'desc'

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

updatedAtMinstring date-time

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

updatedAtMaxstring date-time

Return approvals updated at or before this time.

createdAtMinstring date-time

Return approvals created at or after this time.

createdAtMaxstring date-time

Return approvals created at or before this time.

statusesstring[]

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

postIdsstring[]

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

approverIdsstring[]

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

requestedByIdsstring[]

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

Response

Paginated list of workspace approvals

nextCursorstring nullable

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

hasMoreboolean

Whether more approvals are available

Changes