Documentation Index
Fetch the complete documentation index at: /llms.txt
Use this file to discover all available pages before exploring further.
Pass several values, filter collections and expand references
GET /threads?accountLinkId=df6jbw4h36qm5d9iu2sgn7kx&accountLinkId=k2m5j0xn4wq7ybftcaelp8rv
ids[]=…, filter[tag]=…) and comma-separated values aren’t
supported. tag=a,b looks for one tag named a,b.URLSearchParams, use append:
const params = new URLSearchParams({ folder: "inbox" });
for (const tag of ["hot-lead", "demo-requested"]) params.append("tag", tag);
const url = `https://inboxapp.com/api/v2/threads?${params}`;
import os
import requests
response = requests.get(
"https://inboxapp.com/api/v2/threads",
headers={"Authorization": f"Bearer {os.environ['INBOX_API_TOKEN']}"},
params={"folder": "inbox", "tag": ["hot-lead", "demo-requested"]},
)
response.raise_for_status()
true or false. Numbers are plain digits. Timestamps are ISO 8601 in UTC.
expand embeds the related resource next to its ID field, one path per key, at most 4 per request:
GET /threads?expand=contact&expand=profile
| Resource | Paths |
|---|---|
| Thread | profile, contact, accountLink, assignee |
| Message | sentBy, reactions.author, thread, accountLink, replyTo.message |
| Contact | status, tags, assignee |
{
"id": "l44e15irdq4db30i77cgphhx",
"contactId": "nq2r8v5ycx1t7m4hj6kd3wzb",
"contact": { "id": "nq2r8v5ycx1t7m4hj6kd3wzb", "statusId": null }
}
null.
PATCH body, an omitted field is left unchanged and null clears a nullable field.
curl -X PATCH "https://inboxapp.com/api/v2/contacts/nq2r8v5ycx1t7m4hj6kd3wzb" \
-H "Authorization: Bearer $INBOX_API_TOKEN" \
-H "Content-Type: application/json" \
-d '{ "notes": null }'
Was this page helpful?