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