Skip to main content
GET
Search contacts

Authorizations

Authorization
string
header
required

OAuth 2.1 access tokens issued by Stytch Connected Apps.

x-api-key
string
header
required

API usage-plan key. Required on every request, sent as the x-api-key header.

Query Parameters

page
integer
default:1
Required range: x >= 1
pageSize
integer
default:50
Required range: 1 <= x <= 200
sortBy
enum<string>
Available options:
fullName,
email,
emailStatus,
groupCount,
source,
dateTimeCreated
sortDirection
enum<string>
default:desc
Available options:
asc,
desc
keyword
string
name
string
emailExact
string
phoneExact
string
groupId
integer
excludedGroupId
integer
excludeCrmLinkedContacts
boolean
contactIds
integer[]

Response

Paginated contacts.

data
object[]
required
pageInfo
object
required