INinkbox
SMS Opt-Ins

List Sms Opt Ins

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

Request

  • Base URL
    https://api.inkbox.ai (the document declares no server; this is the origin it was published from)
  • URL
    https://api.inkbox.ai/api/v1/phone/sms-opt-ins
  • Auth
    • API key in header X-API-Key
    • or HTTP bearer

Query parameters

status'opted_in' | 'opted_out'

Filter by consent state. Omit to return both.

limitinteger

Max rows to return.

offsetinteger

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 operation across all 38 revisions of this API.