FUfullpath
consents

List consents in a date window

Returns paginated consent statuses for the target dealer whose source_date falls in [from, to].

Only contacts the authenticated vendor has previously written are included (active preferences with source=vendor and matching source_id).

Limits:

  • from ≤ to
  • Maximum window is 14 days (422 if exceeded)
  • Date-only values (Y-m-d) are accepted; from is start of day and to is end of day
  • Default per_page is 100; maximum is 500

Empty result: 200 with data: [].

Requires client_key (query string) to identify the target dealer.

get/{contact_type}/consents

Request

Path parameters

contact_type'email' | 'phone_sms' | 'phone_call' required

Channel the consent applies to.

Query parameters

client_keystring required

Fullpath client key for the target dealer (format 40NM-{number}-1). Required on all consent endpoints.

fromstring date required

Start of the consent source_date window (inclusive). Prefer Y-m-d (e.g. 2026-06-25); ISO-8601 datetimes are also accepted. Date-only values use start of day.

tostring date required

End of the consent source_date window (inclusive). Must be on or after from, and within 14 days of from. Prefer Y-m-d; ISO-8601 datetimes are also accepted. Date-only values use end of day.

pageinteger

Page number (1-based).

per_pageinteger

Page size. Defaults to 100; maximum 500.

Response

Paginated consent list for the date window.

Example response

{
  "data": [
    {
      "contact_value": "user@example.com"
    }
  ],
  "meta": {
    "current_page": 1,
    "per_page": 100,
    "total": 1,
    "last_page": 1
  }
}

Changes

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