People

List of People

Returns a paginated list of people records in the organization. Supports filtering by search term, teams, custom fields, and other query parameters. Build people directories, sync HR data, or power search interfaces across your workforce records.

Token scopes: people:read

Deprecated: a newer version of this endpoint is available. This version is scheduled for removal on 2027-09-30.

Beta version available: version 2026-09-30 of this endpoint is in beta. Send X-Beta: true to call it.

get/people

Request

  • Base URL: https://api.letsdeel.com/rest
  • URL: https://api.letsdeel.com/rest/people
  • Auth: HTTP bearer

Query parameters

offsetinteger

Return a page of results with given number of records.

limitinteger

Return a page of results with given number of records.

searchstring

Include a contract if by name or contractor name contains given search term.

teamsstring[]

Filter the results based on the team(group) the users contract is associated with

fieldsPeopleGetParametersFieldsSchemaItems[]

Pick the fields you want to see in the response in order to avoid a bloated people list output. Supports dot notation (e.g., 'employments[0].contract_status') to access nested fields.

sort_by'id' | 'first_name' | 'last_name' | 'full_name' | 'email' | 'country' | 'birth_date' | 'hiring_type' | 'start_date' | 'team' | 'job_title' | 'hiring_status' | 'completion_date' | 'direct_manager' | 'direct_reports_count' | 'band_placement' | 'comparative_ratio'

Sort people by given field name.

sort_order'asc' | 'desc'

Order direction of results; ascending or descending.

hiring_statusesPeopleGetParametersHiringStatusesSchemaItems[]

Employee's current hiring status.

band_placementsPeopleGetParametersBandPlacementsSchemaItems[]

Employee's current band placement.

comparative_ratios_fromstring

Employee's minimum band placement

comparative_ratios_tostring

Employee's maximum band placement

hiring_typesPeopleGetParametersHiringTypesSchemaItems[]

Filter people by hiring types

person_statusesPeopleGetParametersPersonStatusesSchemaItems[]

Filter people by person (worker profile) lifecycle status.

Response

Successful response

Changes

No recorded changes to this operation across all 1 revision of this API.