Get BigCommerce agent threads

Retrieves a list of conversation threads/sessions for AI agents on a BigCommerce channel.

get/bigcommerce/channels/{channelId}/threads

Request

Base URL
https://api.takeshape.io
Auth
HTTP bearer

Path parameters

channelIdnumber required

Example:1

The unique identifier for a channel

Query parameters

firstinteger

Example:20

Number of items to return

lastinteger

Example:20

Number of items to return from the end

afterstring uuid

Example:550e8400-e29b-41d4-a716-446655440000

Cursor for pagination (returns items after this ID)

beforestring uuid

Example:550e8400-e29b-41d4-a716-446655440000

Cursor for pagination (returns items before this ID)

querystring

Example:name:"myAgent"

Search query (Stripe-style)

sort'asc' | 'desc'

Example:asc

Sort order for pagination

Response

List of threads retrieved successfully

Example response

{
  "threads": [
    {
      "id": "01234567-89ab-cdef-0123-456789abcdef",
      "agentName": "my-agent",
      "status": "created",
      "createdAt": "2024-01-01T12:00:00Z",
      "updatedAt": "2024-01-01T12:05:00Z",
      "lastMessageOutput": {
        "data": {
          "references": [
            {
              "_tid": "01234567-89ab-cdef-0123-456789abcdef"
            }
          ]
        }
      }
    }
  ]
}

Changes

No recorded changes to this operation across all 1 revision of this API.