Get person UUIDs

Headers

x-api-key

any

Api key required to authenticate your request. Please reach out to monument for a key.

Example:

"monument-2230012-2312321"

Path Parameters

Query Parameters

updatedAt.lessOrEqual

string

Filter people with updatedAt less than or equal to this date-time

updatedAt.greaterOrEqual

string

Filter people with updatedAt greater than or equal to this date-time

createdAt.lessOrEqual

string

Filter people with createdAt less than or equal to this date-time

createdAt.greaterOrEqual

string

Filter people with createdAt greater than or equal to this date-time

onlyPrimaryContacts

boolean

required

limit

number

globalFilterFacilityIds

string[]

filters

object

Show child attributes

filters[updatedAtLessOrEqual]

string<date-time>

Filter by updatedAt less than or equal to this date-time

Example:

"2024-12-29T00:00:24.245Z"

filters[updatedAtGreaterOrEqual]

string<date-time>

Filter by updatedAt greater than or equal to this date-time

Example:

"2024-12-29T00:00:24.245Z"

filters[createdAtLessOrEqual]

string<date-time>

Filter by createdAt less than or equal to this date-time

Example:

"2024-12-29T00:00:24.245Z"

filters[createdAtGreaterOrEqual]

string<date-time>

Filter by createdAt greater than or equal to this date-time

Example:

"2024-12-29T00:00:24.245Z"

filters[onlyPrimaryContacts]

boolean

default:true

If true, only return persons who are the primaryPersonUuid for accounts. If false include all persons.

Response

200 - application/json

IntegrationAPI

API Reference

Headers

Path Parameters

Query Parameters

Response