consents

Get consent for a contact

Returns the current consent status for a single contact at the target dealer.

When no consent record exists, the response is 200 with opt_in and consent_timestamp set to null (not 404).

Requires client_key to identify the target dealer.

get/{contact_type}/consent

Request

Base URL
https://api.fullpath.com/consent-management
Auth
HTTP bearer
TypeScript
https://skmtc.dev/fullpath/apis/fullpath-api-v1-openapi-3-0/docs/:contact_type/consent/get.ts
A function with typed inputs. Its response is checked against the schema.

Path parameters

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

Channel the consent applies to.

Query parameters

contact_valuestring required

Raw contact identifier to look up. Emails are lowercased; phone numbers are standardized before lookup. The normalized value is echoed in the response.

client_keystring required

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

Response

Consent status for the contact (including when no record exists).

contact_valuestring required

Normalized contact value used for the lookup.

opt_inboolean nullable required

true if opted in, false if opted out, null when no consent record exists for this contact.

consent_timestampstring date-time nullable required

ISO 8601 timestamp of the consent event. null when no consent record exists.

Example response

{
  "contact_value": "user@example.com"
}

Changes

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