Skip to main content
GET
Get contacts

Authorizations

Authorization
string
header
required

See our authentication documentation for how to authorize your requests

Scopes

visitors

Read and write visitors

visitors.readonly

Read visitors

Headers

spacebring-network-id
string<uuid>

The id of the network. Required when using bearer token authentication

Query Parameters

limit
integer

The maximum number of contacts to return. Default is 25.

Required range: 1 <= x <= 100
nextPageToken
string

Token to retrieve the next page of results. Opaque cursor token for retrieving the next page of results. Pass this value as the nextPageToken query parameter in your next request.

locationRef
string<uuid>

The id of the location. Omit it to list the contacts of every location in the network where the caller is an administrator.

createDate
object

The create date filter of items.

Response

OK

contacts
object[]
nextPageToken
string

Opaque cursor token for retrieving the next page of results. Pass this value as the nextPageToken query parameter in your next request.

searchQueryNext
string

Pre-built query string for the next page of results. Contains all active filter parameters combined with the next page token, ready to append to the endpoint URL.