Skip to content

List contacts

GET
/contacts

Return paginated contacts for the authenticated user

page
number
default: 1 >= 1
take
number
default: 10 >= 1 <= 100

Paginated list of contacts

object
totalItems
required

Total contacts found

number
totalPages
required

Total number of pages

number
itemsPerPage
required

Items per page

number
currentPage
required

Current page number

number
currentPageItemCount
required

Items returned in current page

number
data
required

List of contacts

Array<object>
object
id
required

Contact identifier

string
email
required

Contact email address

string format: email
firstName
required

Contact first name

string
nullable
lastName
required

Contact last name

string
nullable
domain
required

Domain derived from email

string
createdAt
required

Creation timestamp

number
updatedAt
required

Last update timestamp

number