Skip to main content
GET
Get Permanent Identities

Authorizations

Authorization
string
header
required

Bearer authentication header of the form Bearer <token>, where <token> is your auth token.

Query Parameters

limit
integer
default:20

Pagination - How many results to return

Required range: x <= 50
offset
integer
default:0

Pagination - How many results to skip

updatedSince
string<date-time>
companyId
integer

Landlord tokens may filter to one tenant company; without it, everything the token sees is returned.

sourceId
string
include
enum<string>[]

Expensive; omitted by default.

Available options:
accessControl.credentials,
accessControl.profiles

Response

200 - application/json

The request has succeeded.

permanentIdentities
object[]
required
pageInfo
object
required