Compliance
List Consents
The lead's consent records, newest first.
API key access
Needs the
compliance:read scope with an API key (ro_pat_...). A signed-in session uses the caller's role.GET
/api/v1/leads/{lead_id}/consentsAuthorizationBearer <token>
Access token from /api/v1/auth/login, or an API key (ro_pat_..., RO-176) from /api/v1/workspaces/current/api-keys: the key implies its workspace and needs the route's scope. MCP connectors (/api/v1/mcp only) may use an OAuth access token (ro_oat_..., RO-284).
In: header
Path Parameters
lead_idstring
Format
uuidQuery Parameters
channel?Channel | null
include_revoked?boolean
Header Parameters
X-Workspace-Id?string | null
Id of the workspace to act on (must be a member).
Response Body
curl -X GET "http://localhost:8000/api/v1/leads/497f6eca-6276-4993-bfeb-53cbbbba6f08/consents?include_revoked=true" \ -H "X-Workspace-Id: string"{
"items": [
{
"id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
"workspace_id": "0967198e-ec7b-4c6b-b4d3-f71244cadbe9",
"lead_id": "9bddab70-98e6-43a9-8f32-c9788b9de0c0",
"channel": "email",
"consent_type": "express_written",
"purpose": "marketing",
"contact_value": "string",
"source": "string",
"evidence": {
"property1": null,
"property2": null
},
"captured_at": "2019-08-24T14:15:22Z",
"revoked_at": "2019-08-24T14:15:22Z",
"revoked_reason": "string",
"created_at": "2019-08-24T14:15:22Z"
}
]
}{
"detail": [
{
"loc": [
"string"
],
"msg": "string",
"type": "string",
"input": null,
"ctx": {}
}
]
}