OPopenintake
Texts

List Text Threads

Changed on

The customer's text conversations, newest activity first by default.

get/texts/threads

Request

  • Base URL
    https://api.openintake.ai (the document declares no server; this is the origin it was published from)
  • URL
    https://api.openintake.ai/texts/threads
  • Auth
    none declared

Query parameters

pageinteger

Page number

page_sizeinteger

Number of items per page

sort_columnstring

Column to sort by

sort_directionstring

Sort direction

searchstring nullable

Search by phone number, contact name, or last message

statusstring

open, archived, or all

unreadboolean nullable

true = only threads with an unread inbound message, false = only read ones

last_directionstring nullable

Reply status: inbound = needs reply (the contact wrote last, or the SMS agent handed them to staff), outbound = waiting on the contact

has_outbound_leadboolean nullable

Filter by whether the thread is linked to an outbound lead

start_datetimestring date-time nullable

Last activity >= this UTC datetime (inclusive)

end_datetimestring date-time nullable

Last activity < this UTC datetime (exclusive)

include_testboolean

Include test threads

Response

Successful Response

totalinteger required
pageinteger required
page_sizeinteger required
total_pagesinteger required
needs_reply_countinteger required

Open threads that need a reply (the contact wrote last, or the SMS agent handed them to staff), ignoring the other filters

Changes

  • 4d3da2f87786Revision changes
    • info

      added the optional property // to the response with the status

    • info

      added the optional property // to the response with the status

    • info

      added the optional property // to the response with the status

  • 1839412f9c61Revision changes
    • info

      added the required property to the response with the status