INinkbox
Contact Correspondence

Get Correspondence

Changed on
get/api/v1/contacts/{contact_id}/correspondence

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/contacts/{contact_id}/correspondence
  • Auth
    • API key in header X-API-Key
    • or HTTP bearer

Path parameters

contact_idstring uuid required

Query parameters

channelsstring[]

Channels to include. Repeat the parameter or use comma-separated values.

afterstring date-time nullable
beforestring date-time nullable
limit_per_channelinteger
email_limitinteger nullable
sms_limitinteger nullable
imessage_limitinteger nullable
calls_limitinteger nullable
whatsapp_limitinteger nullable
cursorstring nullable
order'asc' | 'desc'
content'metadata' | 'preview' | 'full'
transcripts'none' | 'abridged' | 'full'
include_failedboolean
identity_idstring uuid nullable

Response

Successful Response

contact_idstring uuid required
identity_idstring uuid required
next_cursorstring nullable

Changes

  • 7e848337e8bfRevision changes
    • breaking

      added to the / response property oneOf list for the response status

    • warning

      added the new whatsapp enum value to the // response property for the response status

    • info

      added the new optional query request parameter whatsapp_limit

    • info

      added whatsapp discriminator mapping keys to the / response property for the response status

  • 77c7e3ee70cfRevision changes
    • info

      added to the response body allOf list for the response status

    • info

      removed subschema #1 from the response body allOf list for the response status