Skip to main content
GET
Search and paginate Contacts

Authorizations

token
string
query
required

Vida API Token

Query Parameters

q
string

Case-insensitive name, email, or phone search.

id
string

Exact Contact id.

phone
string

Exact phone.

email
string

Exact email.

status
string

Exact status.

source
string

Exact contactSource.

leadSource
string

Exact leadSource.

list
string

Exact Contact List membership.

customFieldPath
string

Exact nested path below customFields, for example objective.lastOutcome.

customFieldValue
string

Exact string value required with customFieldPath.

page
integer

Page number starting at 1. Defaults to 1.

pageSize
integer

Page size. Defaults to 20 and is capped at 100.

sort
string

updatedAt, createdAt, id, name, email, or phone.

order
string

asc or desc.

Response

default - undefined