Skip to main content
GET
Search personnel related events by name

Authorizations

Authorization
string
header
required

Send the full Business API key from Settings -> API Keys, for example Authorization: Bearer sk_your_api_key.

Headers

x-call-source
enum<string>

Identify the caller as api or agent for usage attribution. Defaults to api when omitted.

Available options:
api,
agent

Query Parameters

person_name
string
required

Exact full name. Matching is case-insensitive after trimming; partial and fuzzy matching are not used.

Required string length: 1 - 200
date_start_from
string<date>

Inclusive event start-date lower bound. Defaults to the current date when omitted.

date_start_to
string<date>

Inclusive event start-date upper bound. Omit it for no upper bound.

page
integer
default:1

One-based page number. Use 1 for the first page and increment it while hasMore is true.

Required range: x >= 1
pageSize
integer
default:20

Maximum number of records requested per page. The shared default is 20 and the shared upper limit is 100; individual endpoints can document a lower maximum.

Required range: 1 <= x <= 100

Response

Paginated events, a paid-feature business error, or a per-user concurrency business error

Standard paginated collection of public event summaries.

items
object[]
required

Records returned on the current page or in the current batch.

total
integer
required

Total matching records across all pages.

page
integer
required

One-based page number returned.

pageSize
integer
required

Maximum records requested for this page.

totalPages
integer
required

Total pages available for the current query.

hasMore
boolean
required

Whether another result page is available.