List conversations by company ID

Retrieves a paginated list of conversations associated with a specific company. Supports filtering, sorting, and pagination options.

GET /v1/list-conversations/{company_id}

List conversations for a company (paginated)

cURL

curl --request GET \
  --url https://api.salescaptain.com/v1/list-conversations/{company_id} \
  --header 'Authorization: Bearer <token>'

200

Example

{
  "message": "Conversations fetched successfully!",
  "conversations": {
    "data": [
      {
        "contact_id": "a1b2c3d4-e5f6-7890-abcd-ef1234567890",
        "contact_name": "John Doe",
        "contact_number": "[phone]",
        "contact_email": "[e-mail]",
        "conversation_id": "b2c3d4e5-f6a7-8901-bcde-f12345678901",
        "conversation_profile_id": "c3d4e5f6-a7b8-9012-cdef-123456789012",
        "conversation_profile_number": "[phone]",
        "conversation_profile_email": "[e-mail]",
        "last_message": "Hey, I need help with my order",
        "assigned_to": "d4e5f6a7-b8c9-0123-def1-234567890123",
        "updated_at": "2026-03-17T10:30:00.000Z",
        "created_at": "2026-03-15T08:00:00.000Z",
        "seen_by": "e5f6a7b8-c9d0-1234-ef12-345678901234",
        "is_chat_opened": true
      },
      {
        "contact_id": "f6a7b8c9-d0e1-2345-f123-456789012345",
        "contact_name": "Jane Smith",
        "contact_number": "[phone]",
        "contact_email": "[e-mail]",
        "conversation_id": "a7b8c9d0-e1f2-3456-1234-567890123456",
        "conversation_profile_id": "c3d4e5f6-a7b8-9012-cdef-123456789012",
        "conversation_profile_number": "[phone]",
        "conversation_profile_email": "[e-mail]",
        "last_message": "Thanks for the update!",
        "assigned_to": null,
        "updated_at": "2026-03-16T14:20:00.000Z",
        "created_at": "2026-03-10T12:00:00.000Z",
        "seen_by": null,
        "is_chat_opened": false
      }
    ],
    "pagination": {
      "page_number": 1,
      "items_per_page": 10,
      "total_count": 25,
      "total_pages": 3
    }
  }
}

Authorizations

Authorization · string · header · required

Authentication token required for accessing protected endpoints. The token should be obtained from the main SalesCaptain authentication service.

Path Parameters

company_id · string<uuid> · required

Unique identifier for the company

Example:

"a1b2c3d4-e5f6-7890-abcd-ef1234567890"

Query Parameters

page_number · integer · required

Page number for pagination (must be a positive integer)

Required range: x >= 1

Example:

1

items_per_page · integer · default: 10

Number of items per page (10-100, default 10)

Required range: 10 <= x <= 100

Example:

10

sort_by · enum<string>

Field to sort by

Available options: last_update

Example:

"last_update"

sort_dir · enum<string> · default: desc

Sort direction (default desc)

Available options: asc, desc

Example:

"desc"

number · string

Filter conversations by contact phone number

Example:

"[phone]"

email · string<email>

Filter conversations by contact email address

Example:

"[e-mail]"

conversation_profile_id · string<uuid>

Filter conversations by conversation profile ID

Example:

"c3d4e5f6-a7b8-9012-cdef-123456789012"

chat_status · enum<string>

Filter conversations by chat status

Available options: open, closed

Example:

"open"

Response

200

application/json

Conversations fetched successfully

message · string

Example:

"Conversations fetched successfully!"

conversations · object

Show child attributes