Consent

List consent records

List all consent records for the authenticated API key owner, paginated and filterable. Returns consents recorded via both the embeddable banner (source: "banner") and the POST /api/v1/consent API (source: "api"). Use the cursor returned in next_cursor to page.

get/api/v1/consent

Request

  • Base URL: https://policyforge.co
  • URL: https://policyforge.co/api/v1/consent
  • Auth: HTTP bearer

Query parameters

fromstring date-time

Lower bound on recorded_at (ISO 8601). Inclusive.

tostring date-time

Upper bound on recorded_at (ISO 8601). Inclusive.

end_user_idstring

Filter to a single end-user. Equivalent to GET /api/v1/consent/{userId} but with the same paginated shape.

policy_versionstring

Filter by the policy_version stamp recorded with each consent.

policy_idstring uuid

Filter to consents for a specific policy. Set on banner consents (when the banner is linked to a cookie policy), hosted-policy 'I Agree' clicks, and API-recorded consents that included a policy_id.

banner_config_idstring uuid

Filter to consents recorded via a specific consent banner.

source'banner' | 'api'

Filter by source. banner = recorded via the embeddable cookie banner. api = recorded via POST /api/v1/consent (e.g. ToS-at-checkout).

limitinteger

Page size. Max 200.

cursorstring

Opaque cursor returned as next_cursor in the previous page. Pass it back to fetch the next page. Stable across same-timestamp rows.

Response

Paginated list of consent records

page_sizeinteger

Number of records returned in this page.

limitinteger

Limit applied to this query.

total_countinteger nullable

Total matching records across all pages.

next_cursorstring nullable

Cursor to pass back as ?cursor= for the next page. null when there are no more pages.

Changes

No recorded changes to this operation across all 1 revision of this API.