Sign in
SMS Opt-Ins

List Sms Opt Ins

get/api/v1/phone/sms-opt-ins

Query parameters

status'opted_in' | 'opted_out'

Filter by consent state. Omit to return both.

limitinteger

Max rows to return.

Max rows to return.

offsetinteger

Number of rows to skip.

Number of rows to skip.

Response

Successful Response

idstring uuid required
organization_idstring required
receiver_numberstring required
status'opted_in' | 'opted_out' required
source'sms' | 'api' required
opted_in_atstring date-time nullable required
opted_out_atstring date-time nullable required
created_atstring date-time required
updated_atstring date-time required

Changes

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