search.people

Search people with structured filters.

Signature

people(body: SearchPeopleBody & SearchPeopleQuery): Promise<SearchPeopleResult>

Example

import { Curviate } from "@curviate/sdk";
 
const curviate = new Curviate({
  apiKey: "cvt_live_…",
  baseUrl: "https://api.curviate.com",
});
 
const page = await curviate.account("acc_YOUR_ACCOUNT_ID").search.people();
for (const item of page.items ?? []) {
  console.log(item.id);
}
// `page.cursor` is the opaque cursor for the next page (null when exhausted).

Parameters

Returns

Resolves to SearchPeopleResult. Top-level fields: object, items, paging, cursor.

Error codes

• UNAUTHORIZED
• INVALID_REQUEST
• RATE_LIMIT_ACCOUNT
• RATE_LIMIT_TENANT
• PLATFORM_RATE_LIMIT
• PLATFORM_ERROR
• RESOURCE_NOT_FOUND

All error codes link to Error codes reference.

Notes

Note: The account_id is injected automatically by the account-scoped accessor. Call as curviate.account("acc_YOUR_ACCOUNT_ID").search.people(...).