profiles

List profiles

Returns profiles for the authenticated organization with cursor-based pagination and directory filters.

get/profiles

Request

Base URL
https://api.usecrouton.com
Auth
- HTTP bearer
- or API key in header X-Api-Key
TypeScript
https://skmtc.dev/usecrouton/apis/crouton-api/docs/profiles/get.ts
A function with typed inputs. Its response is checked against the schema.

Maximum number of items to return per page.

Opaque cursor from a previous page response.

Free-text match across profile names and emails.

Filter by exact email address.

Filter by job title.

Filter by location name.

Filter by employee type.

Filter to active or inactive profiles.

Filter to profiles with a start date on or after this ISO date.

Filter to profiles with a start date before this ISO date (exclusive upper bound).

Filter to profiles with an end date on or after this ISO date.

Filter to profiles with an end date before this ISO date (exclusive upper bound).

A page of profiles.

No recorded changes to this operation across all 3 revisions of this API.