Search Contacts

get

https://api.soldo.com/business/v2/contacts

Endpoint to search Contacts using filtering parameters.

Recent Requests

Time	Status	User Agent
Retrieving recent requests…

Loading…

Required scopes:

contact_read

Query Params

statuses

array of objects, unique

The status to search Contacts by. Multiple values are allowed. If omitted, Contacts in both CREATED and SUGGESTED status are returned.

name

array of strings, unique

The name to search Contacts by. Multiple values are allowed.

name

type

array of objects, unique

The type to search Contacts by. Multiple values are allowed.

countries

array of objects, unique

The ISO 3166-1 alpha-3 code of the country to search Contacts by. Multiple values are allowed.

user

array of strings, unique

The ID of the User the Contact is assigned to, to search Contacts by (only Contacts of type EMPLOYEE are assigned to a User). Multiple values are allowed.

user

int32

Defaults to 0

It indicates the specific page to display (the counter starts from zero).

int32

≤ 50

Defaults to 0

It indicates the number of items per page.

string

enum

It indicates how the pages are ordered.

Allowed:

props

array of strings

It indicates the sorting direction applied to the above parameters. To apply a sorting on multiple parameters, set as many times the props parameter in the request.

props

Responses

400

Your request has missing arguments or is malformed.

Required scopes:

200The returned result is a list of Contacts.