Skip to main content
GET
List conversations

Authorizations

x-conveyour-token
string
header
required

Your API key token. Contacts endpoints require a Server-only — Full API key — see Authentication.

Query Parameters

type_id
string

Filter to conversations for a specific contact ID.

threads
boolean

When true and type_id is set, returns threads for the contact rather than the full conversation.

thread_id
string

Filter to a specific conversation thread.

Search within conversations.

closed
boolean

When true, includes closed/resolved conversations. Default: false.

skip
integer

Number of records to skip for pagination. Default: 0.

assigned_to
string

Filter to conversations assigned to a specific user.

users
string[]

Filter conversations by assigned user IDs. Pass as repeated query params.

search_type_ids
string[]

Filter by message type IDs. Pass as repeated query params.

teams[]
string[]

Team scope for the request, as one or more team ObjectIds. The brackets are required: PHP keeps only the last value for a repeated plain key, so teams=A&teams=B silently resolves to B alone. On requests with a JSON body you may send teams (no brackets) in the body instead.

Values that are not valid ObjectIds are silently ignored — a mistyped team ID behaves as if no team was sent. See the teams section of the API conventions guide.

type
string

Conversation type. Defaults to contact.

debug
boolean
default:false

Include debug detail in the response.

Response

Success.

The common response envelope shared by all ConveYour endpoints.

status
enum<string>

ok on success, failed on error.

Available options:
ok,
failed
message
string

Human-readable description of the result.

data
object[]

The response payload — an object or an array depending on the endpoint.