Skip to main content
POST
cURL

Authorizations

Authorization
string
header
required

Bearer authentication header of the form Bearer <token>, where <token> is your auth token.

Query Parameters

page
number

Page number

limit
number

Page size

Body

application/json
email
string
text
string

Search in both email & id

ids
string[]
firstName
string
Pattern: ^[0-9A-Za-zÀ-ÖØ-öø-ÿ ,.'- ]{1,60}$
lastName
string
Pattern: ^[0-9A-Za-zÀ-ÖØ-öø-ÿ ,.'- ]{1,60}$
authProvider
string
status
enum<string>
Available options:
pending,
validated,
deactivated
platformRole
string
groups
string[]

Response

Success Response

contacts
object[]
required
size
number

Total number of matching contacts