Skip to main content
GET
/
v1
/
messaging
/
threads
List message threads
curl --request GET \
  --url https://api.tybritelabs.com/v1/messaging/threads \
  --header 'Authorization: Bearer <token>' \
  --header 'x-auth-token: <x-auth-token>'
{
  "threads": [
    {
      "id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
      "customer_id": "<string>",
      "customer_name": "<string>",
      "customer_email": "<string>",
      "customer_phone": "<string>",
      "store_name": "<string>",
      "store_avatar": "<string>",
      "order_id": "<string>",
      "product_id": "<string>",
      "subject": "<string>",
      "last_message_at": "2023-11-07T05:31:56Z",
      "unread_count_customer": 123,
      "unread_count_store": 123,
      "is_archived": true,
      "is_muted": true,
      "is_pinned": true,
      "created_at": "2023-11-07T05:31:56Z",
      "updated_at": "2023-11-07T05:31:56Z"
    }
  ],
  "pagination": {
    "limit": 123,
    "next_cursor": "<string>",
    "has_more": true
  }
}

Documentation Index

Fetch the complete documentation index at: https://docs.tybritelabs.com/llms.txt

Use this file to discover all available pages before exploring further.

Authorizations

​
Authorization
string
header
required

API Key Authentication

Use your API key in the Authorization header:

Authorization: Bearer tybrite_sk_live_YOUR_KEY

Key Types:

Secret Keys (Server-Side Only):

  • Format: tybrite_sk_live_* (production) or tybrite_sk_test_* (sandbox)
  • Full read/write access to all endpoints
  • ⚠️ NEVER expose in client-side code or public repositories
  • Required for: write operations, authentication, payment verification, AI recommendations

Publishable Keys (Client-Safe):

  • Format: tybrite_pk_live_* (production) or tybrite_pk_test_* (sandbox)
  • Read-only access (GET requests only, plus POST semantic search)
  • ✅ Safe for client-side JavaScript, mobile apps, and public code
  • Allowed for: browsing products, search, CMS content, pricing queries

Endpoint-Specific Requirements:

  • Authentication endpoints (/v1/auth/*): Secret key required
  • Payment verification (POST /v1/payments/verify): Secret key required
  • AI Recommendations (POST /v1/recommendations): Secret key required
  • Semantic Search (POST /v1/search): Both key types allowed (read-only operation)
  • All write operations: Secret key required
  • All read operations: Both key types allowed

Using a publishable key for restricted operations returns 403 Forbidden.

Headers

​
x-auth-token
string
required

Customer session access_token. Required to prove ownership of the thread/message being accessed.

Query Parameters

​
customer_id
string<uuid>
required

Customer UUID to filter threads by

​
status
enum<string>

Filter threads by status

Available options:
active,
resolved,
closed,
escalated,
pending
​
priority
enum<string>

Filter by priority level

Available options:
urgent,
high,
normal,
low
​
thread_type
enum<string>

Filter by thread type

Available options:
general,
order_inquiry,
product_inquiry,
support,
complaint,
delivery,
return,
refund,
technical
​
archived
boolean

true = archived threads only, false = non-archived only, omit = no filter

​
unread
boolean

Set to true to return only threads with unread_count_store > 0

​
limit
integer
default:50
Required range: 1 <= x <= 200
​
cursor
string

Cursor for pagination (base64-encoded last_message_at value)

​
fields
string

Comma-separated list of fields to include in the response.

Allowed Fields:

  • id, customer_id, customer_name, customer_email, customer_phone
  • store_name, store_avatar, order_id, product_id
  • subject, thread_type, status, priority
  • last_message_at, last_message_by, unread_count_customer, unread_count_store
  • is_archived, is_muted, is_pinned
  • created_at, updated_at

Response

Success

​
threads
object[]
​
pagination
object