Skip to main content
GET
List mandates
Required scope: AGENTIC_READ

Authorizations

Authorization
string
header
required

API key as Bearer token

Headers

Reap-Version
enum<string>
required

API version (YYYY-MM-DD)

Available options:
2025-02-14
Example:

"2025-02-14"

Reap-Subproject-Id
string<uuid>

Selects the subproject the request operates on; only accepted with a parent project credential.

Query Parameters

ownerType
enum<string>
default:CLIENT_REFERENCE
Available options:
REAP_USER,
CLIENT_REFERENCE
Example:

"REAP_USER"

ownerId
string
required
Minimum string length: 1
enrollmentId
string<uuid>
status
enum<string>[]

Filter by mandate status (comma-separated). Defaults to ACTIVE; pass an explicit value to include other statuses.

Available options:
REQUIRES_ACTION,
ACTIVE,
PAUSED,
CONSUMED,
EXPIRED,
FAILED,
CANCELLED,
REVOKED
limit
integer
default:20

Maximum number of mandates to return

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

Response

Response for status 200

items
object[]
required
nextCursor
string | null
required