Skip to main content
GET
Retrieve visits

Authorizations

Authorization
string
header
required

See our authentication documentation for how to authorize your requests

Scopes

visitors.readonly

Read visitors

visitors

Read and write visitors

Headers

spacebring-network-id
string<uuid>

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

Query Parameters

locationRef
string<uuid>

The id of the location. Omit it to list the visits of every location in the network, newest visit date first.

userRefHost
string<uuid>

The id of the user, host of the visit.

userRefVisitor
string<uuid>

The id of the user, visitor of the visit.

createDate
object

The date filter of items.

date
object

The visit date filter of items.

limit
integer<int64>
default:25

The number of items to return

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.

Response

OK

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.

visits
object[]