Skip to main content
GET
Search organization people

Авторизації

Authorization
string
header
обов'язково

Short-lived bearer access token issued for a Living Security API access key. Send as Authorization: Bearer .

Заголовки

x-organization-id
string<uuid>
обов'язково

Organization context for multi-tenant operations

Параметри запиту

Search term for text search across name and email fields

Приклад:

"john"

offset
number
за замовчуванням:0

Offset for pagination (number of records to skip)

Необхідний діапазон: x >= 0
cursor
string

Cursor for pagination (returned from previous response)

Приклад:

"eyJvZmZzZXQiOjUwfQ=="

limit
number
за замовчуванням:50

Maximum number of results to return per page

Необхідний діапазон: 1 <= x <= 100
firstName
string

Filter by first name (partial match, case-insensitive)

Приклад:

"John"

lastName
string

Filter by last name (partial match, case-insensitive)

Приклад:

"Doe"

email
string

Filter by email (partial match, case-insensitive)

Приклад:

"john@example.com"

personId
string

Filter by specific person ID (exact match)

Приклад:

"01234567-89ab-cdef-0123-456789abcdef"

active
boolean

Filter by active status

Приклад:

true

includeTotal
boolean

Include the exact count of all people matching the same filters. Defaults to false to avoid count-query overhead for autocomplete/search consumers.

Приклад:

true

roles
string[]

Filter by roles

createdAfter
string

Filter by created date (after this date)

Приклад:

"2025-01-01T00:00:00Z"

createdBefore
string

Filter by created date (before this date)

Приклад:

"2025-12-31T23:59:59Z"

sortBy
enum<string>
за замовчуванням:createdAt

Field to sort by

Доступні опції:
name,
email,
createdAt,
status
Приклад:

"name"

sortDirection
enum<string>
за замовчуванням:DESC

Sort direction (ASC or DESC)

Доступні опції:
ASC,
DESC
Приклад:

"ASC"

Відповідь

People found successfully

people
object[]
обов'язково

List of people matching search criteria

pagination
object
обов'язково

Pagination metadata

totalCount
number | null

Exact count of all people matching the same filters. Present only when requested with includeTotal=true.

Приклад:

1234