Guardrails
List guardrail bindings
Returns your organization's guardrail bindings, newest first, with
cursor pagination. The next-page token is returned in
meta.next_cursor and is null on the last page.
A binding attaches a profile to a scope (a brand, campaign, number,
pool, or the organization default). The single organization-default
binding has all four scope ids null and scope_kind: use_case_default.
Requires the org: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
50Range
1 <= value <= 100Response Body
application/json
application/json
application/json
application/json
curl -X GET "https://example.com/v1/guardrails/bindings"{
"success": true,
"error": {
"code": "string",
"message": "string",
"request_id": "string",
"details": {
"property1": "string",
"property2": "string"
}
},
"meta": {
"total": 0,
"limit": 0,
"offset": 0,
"next_cursor": "eyJjcmVhdGVkX2F0IjoiMjAyNi0wNC0yNlQxMjowMDowMFoiLCJpZCI6IjAxOTAwMDAwLTAwMDAtMDAwMC0wMDAwLTAwMDAwMDAwMDAwMSJ9",
"last_event_at": "2019-08-24T14:15:22Z"
},
"data": [
{
"id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
"org_id": "a40f5d1f-d889-42e9-94ea-b9b33585fc6b",
"scope_kind": "use_case_default",
"brand_id": "1bb61461-e5e3-4ebb-8cc6-5b0c37f1b7da",
"campaign_id": "78614b6c-fe7c-41e2-8e25-c9b3a3c91904",
"phone_number_id": "54afc7b8-17df-415a-9fb0-21ee66219576",
"pool_id": "bd9ee216-b2f2-496a-bbe1-31b86a2c3c43",
"profile_id": "bfcb6779-b1f9-41fc-92d7-88f8bc1d12e8",
"created_at": "2019-08-24T14:15:22Z",
"updated_at": "2019-08-24T14:15:22Z"
}
]
}{
"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"
}
}
}