Skip to main content
GET
/
chats
/
{resourceType}
/
{resourceId}
List Chats for Resource
curl --request GET \
  --url https://app.splox.io/api/v1/chats/{resourceType}/{resourceId} \
  --header 'Authorization: Bearer <token>'
{
  "chats": [
    {
      "id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
      "name": "<string>",
      "user_id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
      "resource_type": "api",
      "resource_id": "<string>",
      "is_public": true,
      "public_share_token": "<string>",
      "metadata": {},
      "created_at": "2023-11-07T05:31:56Z",
      "updated_at": "2023-11-07T05:31:56Z"
    }
  ]
}
Lists all chat sessions for a specific resource (workflow, agent, etc.).

Usage

curl https://app.splox.io/api/v1/chats/api/019c3221-29d7-70e1-aa1e-dee02589289b \
  -H "Authorization: Bearer YOUR_TOKEN"

Path Parameters

ParameterTypeDescription
resourceTypestringResource type: api, workflow, agent, gui
resourceIdstring (uuid)The resource ID (e.g., workflow ID)

Response

{
  "chats": [
    {
      "id": "0199f200-a11b-7c8d-4444-888890abcdef",
      "name": "My Chat Session",
      "user_id": "0199d001-c45d-9e0f-3456-789012cdef01",
      "resource_type": "api",
      "resource_id": "019c3221-29d7-70e1-aa1e-dee02589289b",
      "is_public": false,
      "created_at": "2025-10-22T10:00:00Z",
      "updated_at": "2025-10-22T10:00:00Z"
    }
  ]
}

Notes

Authentication required. For agent resource type, only the authenticated user’s chats are returned. For other types, all chats for the resource are returned.

Authorizations

Authorization
string
header
required

API token generated from your Splox account settings. Create tokens at https://app.splox.io/account?tab=settings

Path Parameters

resourceType
enum<string>
required

Resource type

Available options:
api,
workflow,
agent,
gui
resourceId
string<uuid>
required

Resource ID (e.g., workflow ID)

Response

200 - application/json

Chats retrieved successfully

chats
object[]