Customers

List customers

Returns customers in your workspace. Pagination is controlled by offset and limit.

get/customers/

Request

  • Base URL: https://api.landbot.io/v1
  • URL: https://api.landbot.io/v1/customers/
  • Auth: API key in header Authorization

Query parameters

channel_idinteger

Filter by channel.

agent_idinteger

Filter by assigned agent.

search_by'name' | 'email' | 'phone'

Field to search on.

searchstring

Prefix to match against search_by.

archivedboolean

Filter by archive status.

opt_inboolean

Filter by WhatsApp opt-in status.

offsetinteger
limitinteger

Response

List of customers.

successboolean
totalinteger

Total number of matching customers, ignoring pagination.

Changes

No recorded changes to this operation across all 1 revision of this API.