List threads

GET

/operations/order_internal_messages/threads/list/v1

GET

/operations/order_internal_messages/threads/list/v1

import { ChrtClient } from "@chrt-inc/typescript-sdk";
async function main() {
    const client = new ChrtClient({
        token: "YOUR_TOKEN_HERE",
    });
    await client.operations.orderInternalMessages.listThreadsV1({
        filter_last_message_at_timestamp_gte: "2024-01-15T09:30:00Z",
        filter_last_message_at_timestamp_lte: "2024-01-15T09:30:00Z",
        filter_order_ids: [
            "filter_order_ids",
        ],
        filter_order_statuses: [
            "draft",
        ],
        filter_unread: true,
        page: 1,
        page_size: 1,
    });
}
main();

{
  "items": [
    {
      "last_message": {
        "message": "message",
        "org_id": "org_id",
        "timestamp": "2024-01-15T09:30:00Z",
        "user_id": "user_id"
      },
      "message_count": 1,
      "order_id": "order_id",
      "order_short_id": "order_short_id",
      "order_status": "draft",
      "unread_count": 1,
      "order_off_chrt_reference_id": "order_off_chrt_reference_id"
    }
  ],
  "total_count": 1,
  "total_unread_count": 1
}

Lists the caller’s org internal message threads across orders, newest message first, each with its last message and the caller’s unread count. | authz: allowed_org_types=[provider], min_org_role=operator | () -> (OrderInternalMessageThreadListRes)

Authentication

AuthorizationBearer

Bearer authentication of the form Bearer <token>, where token is your auth token.

Query parameters

filter_order_statusesenumOptional

Filter by order status(es); defaults to draft, staged, and in_progress

filter_order_idsstringOptional

Filter by order id(s)

filter_unreadbooleanOptional

True keeps threads with messages the caller hasn’t read; False keeps fully read threads

filter_last_message_at_timestamp_gtedatetimeOptional

Filter last message timestamp >= value

filter_last_message_at_timestamp_ltedatetimeOptional

Filter last message timestamp <= value

pageintegerOptional>=1Defaults to 1

page_sizeintegerOptional1-100Defaults to 20

Response

Successful Response

itemslist of objects

total_countinteger

total_unread_countinteger

Errors

422

Order Internal Messages List Threads V1request Unprocessable Entity Error