HIhint
CommunicationAuthorization

List Communication Authorizations

Changed on

Returns the practice's marketing authorization rows for email addresses. Rows are created lazily, so an address that was never explicitly acted on has no row — ?state=opted_out is the exhaustive suppression list.

get/provider/communication_authorizations

Request

  • Base URL
    https://api.sandbox.hint.com/api
  • URL
    https://api.sandbox.hint.com/api/provider/communication_authorizations
  • Auth
    API key in header AUTHORIZATION

Query parameters

limitinteger

Allows limiting the number of authorizations returned.

offsetinteger

Allows offsetting the start of the returned page.

categorystring

Filter by authorization category (marketing).

statestring

Filter by state (opted_in, opted_out).

emailstring

Scope to a single email address. Normalized (downcased and trimmed) before matching.

updated_atstring date-time

Allows filtering by date or time. Accepts an object with allowed keys of [gte, gt, lte, lt] and a value of the date or time in iso8601 format. See advanced querying for more information.

created_atstring date-time

Allows filtering by date or time. Accepts an object with allowed keys of [gte, gt, lte, lt] and a value of the date or time in iso8601 format. See advanced querying for more information.

Response

Successful response

Changes