Ferndesk

List conversations

Lists and searches the Support inbox's conversations, newest activity first. Filters combine. With query, only the conversations it finds, best match first (at most 200), each with search: the passage that matched and where.

GET /v1/conversations
Bearer token scope inbox:read

Query parameters

· 16
limit integer · min: 1· max: 100· default: 25

Items per page, 1 to 100.

cursor string · min length: 1

The next_cursor of the previous page. Only valid with the same endpoint and filters.

query string · max length: 200

Words to find in the subject, the customer (name, email, properties) and every message and internal note.

mode string · enum

With query: keyword matches its words, semantic its meaning, hybrid (the default) both, best match first.

values

  • keyword
  • semantic
  • hybrid
status string | array of string

Only these statuses. Repeat the parameter or separate values with commas.

assignee string | array of string

Only conversations assigned to these teammates (mem_...), or "unassigned". Repeat the parameter or separate values with commas.

label_ids string | array of string

Only conversations with any of these labels (tag_...). Repeat the parameter or separate values with commas.

channel string | array of string

Only these channels. Repeat the parameter or separate values with commas.

priority string | array of string

Only these priorities. Repeat the parameter or separate values with commas.

customer_id string · min length: 1

Only this customer (cust_...).

Responses