Consent
List consent records
Page over your organization's consent records, most recently updated first.
Cursor pagination surfaces the next-page cursor in meta.next_cursor;
the last page renders next_cursor: null.
Requires the consent:read scope.
AuthorizationBearer <token>
Authenticate by sending your API key as a bearer token:
Authorization: Bearer am_live_.... Every request is automatically
scoped to the organization that owns the key and to the scopes granted
to that key.
In: header
Query Parameters
cursor?string
limit?integer
Default
20Range
1 <= value <= 100contact_number?string
phone_number_id?string
Format
uuidopted_in?boolean
since?string
Format
date-timeconsent_method?string
Value in
"checkbox" | "sms_keyword" | "written" | "verbal" | "attested" | "double_opt_in" | "hosted_form"Response Body
application/json
application/json
application/json
application/json
curl -X GET "https://example.com/v1/consent"{
"success": true,
"data": [
{
"id": "0190a1b2-c3d4-e5f6-a7b8-c9d0e1f2a3b6",
"org_id": "0190a1b2-c3d4-e5f6-a7b8-c9d0e1f2a3b4",
"phone_number_id": "7c1f0a2d-9e8b-4c3a-9d2e-1f0a2b3c4d5e",
"contact_number": "+15554443333",
"opted_in": true,
"opted_in_at": "2026-04-26T12:00:00Z",
"opted_out_at": null,
"source": "api",
"created_at": "2026-04-26T12:00:00Z",
"updated_at": "2026-04-26T12:00:00Z"
}
],
"meta": {
"total": 0,
"limit": 20,
"offset": 0,
"next_cursor": null
}
}{
"success": false,
"error": {
"code": "UNAUTHORIZED",
"message": "authentication failed",
"request_id": "01JTBQH2FZ8K1RXC0WJ4Z9P3VM"
}
}{
"success": false,
"error": {
"code": "FORBIDDEN",
"message": "missing required scope",
"request_id": "01JTBQH2FZ8K1RXC0WJ4Z9P3VM"
}
}{
"success": false,
"error": {
"code": "VALIDATION_FAILED",
"message": "validation failed",
"request_id": "01JTBQH2FZ8K1RXC0WJ4Z9P3VM",
"details": {
"to": "must be E.164",
"body": "must be 1..1600 chars"
}
}
}