Skip to main content
GET
cURL
Lists the companies of the workspace, most recently created first by default.

Authorizations

X-Claap-Key
string
header
required

Query Parameters

cursor
string

Paginate the results starting at the cursor returned by a previous call.

limit
number
default:20

Return at most "limit" results.

Required range: 1 <= x <= 100
sort
enum<string>

Sort results according to specified rule. Defaults to the sorting of "viewId" when set, "created_desc" otherwise.

Available options:
created_asc,
created_desc,
last_interaction_asc,
last_interaction_desc,
name_asc,
name_desc
viewId
string

Return the companies of the specified view: its filters and sorting apply, and the sort parameter overrides the view sorting. Use GET /v1/companies/views to discover views.

Response

Companies were successfully retrieved

result
object
required