Skip to main content
GET
List conversations for a company (paginated)

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"

filter
enum<string>

Filter conversations by field

Available options:
conversation_profile_id,
number,
email,
chat_status
Example:

"chat_status"

Response

Conversations fetched successfully

message
string
Example:

"Conversations fetched successfully!"

conversations
object