DocumentationAPI Reference

Inbox

List inbox threads

Lists inbox threads in the authenticated account. By default only threads with at least one inbound reply are returned. Newest/Oldest sort and date_from/date_to use last_inbound_at (latest lead reply). The q parameter searches subject, participants, lead identity/company, campaign name, thread tags, and message bodies.

GET/v1/threads

Authorization

bearerAuth
AuthorizationBearer <token>

Use an account API key in the Authorization header: Authorization: Bearer f_....

In: header

Query Parameters

limit?integer

Number of rows to return. Defaults to 20; maximum 100.

Range0 <= value <= 100
Default20
offset?integer

Zero-based offset for pagination.

Range0 <= value
Default0
q?string

Case-insensitive prefix search across thread subject, participants, lead name/email/company, campaign name, thread tags, and message bodies (min 2 characters).

campaign_id?string

Filter inbox threads to a single campaign.

Formatuuid
mailbox_id?string

Filter inbox threads to a single mailbox.

Formatuuid
unread_only?boolean

When true, returns only threads with unread received messages.

Defaultfalse
conversation_status?string

Filter threads by conversation status.

Value in

  • "open"
  • "closed"
category?string

Filter threads by category. Use no_category for uncategorized threads.

Value in

  • "Interested"
  • "Neutral"
  • "Not Interested"
  • "Auto Reply"
  • "no_category"
tag_ids?string

Comma-separated thread tag ids. Returns threads tagged with any listed tag.

date_from?string

Inclusive ISO-8601 timestamp filter on last_inbound_at (latest lead reply).

Formatdate-time
date_to?string

Inclusive ISO-8601 timestamp filter on last_inbound_at (latest lead reply).

Formatdate-time
has_reply_only?boolean

When true (default), returns only threads with at least one inbound reply.

Defaulttrue
curl -X GET "https://example.com/v1/threads"
{  "data": [    {      "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",      "account_id": "449e7a5c-69d3-4b8a-aaaf-5c9b713ebc65",      "campaign_id": "78614b6c-fe7c-41e2-8e25-c9b3a3c91904",      "mailbox_id": "4d23d1af-2eef-4598-a5e0-1f19ae0b0c14",      "subject": "string",      "last_message_at": "2019-08-24T14:15:22Z",      "last_inbound_at": "2019-08-24T14:15:22Z"    }  ],  "limit": 0,  "offset": 0,  "total_count": 0}
{  "error": {    "type": "authentication_error",    "code": "invalid_api_key",    "message": "A valid Furnace API key is required"  }}
{  "error": {    "type": "rate_limit_error",    "code": "rate_limit_exceeded",    "message": "Rate limit exceeded for this account"  }}
{  "error": {    "type": "api_error",    "code": "internal_error",    "message": "Internal server error"  }}