v1

latestOpenAPI 3.0.02026-07-24115101.2 MB
Contact

Get Contacts in a workspace.

Use this endpoint to retrieve the list of contacts in a workspace.

get/contacts

Query parameters

offsetinteger
limitinteger
filter[company_name]string

Filter contact by the company name.

filter[country_code]string country_code

Filter contact by the country.

filter[email]string email

Filter contact by the email.

filter[query]string

Free text search in the following fields: * name * company_name

workspace_idinteger required

The unique ID of the workspace.

sortstring

A comma-separated list of columns by which results are sorted. Valid column:

  • country_code
  • company_name
  • name

Headers

x-oneflow-api-tokenstring required

The API key of your Oneflow account.

x-oneflow-user-emailstring email

The email address of a registered Oneflow user.

Response

Returns the list of contacts.

countinteger required