Skip to content

List all people

Request

You can fetch a list of all people. You can optionally specify a limit to control the number of results returned, and an offset to skip a specified number of entries from the start.

Security
basicAuth
Query
contractTypesArray of strings, (uuid)

Comma-separated list of contract type UUIDs used to filter people by contract types.

Example:contractTypes=41d2e841-7f1f-4545-be09-8a17606f0228,31d2e841-7f1f-4545-be09-8a17606f0228
positionsArray of integers

Comma-separated list of position IDs used to filter people by positions.

Example:positions=1,2,3,4
teamsArray of integers

Comma-separated list of team IDs used to filter people by team membership.

Example:teams=1,2,3,7,8
archivedboolean

Filter by archived status. Set to true to return only archived people, or false to return only active people.

Example:archived=true
projectionstring

Defines the projection strategy used for the response.

  • FULL (default): returns all available fields.
  • BASIC: returns a minimal subset of fields.
  • CUSTOM: returns only the fields specified in the fields parameter. When CUSTOM is used, the fields parameter is required.

Note: Regardless of projection type, the response always includes id, legacyId and archived fields.

Enum:"FULL""BASIC""CUSTOM"
Example:projection=CUSTOM
fieldsstring

Comma-separated list of field names to include in the response. Only applicable when projection=CUSTOM.

Note: Regardless of the list, the fields id, legacyId and archived are always returned.

Example:fields=firstName,lastName,email
limitinteger, >= 1

The maximum number of items to return. Must be greater than or equal to 1. Default is 100.

Default:100
Example:limit=50
offsetinteger, >= 0

The number of items to skip before returning the results. Must be greater than or equal to 0. Default is 0.

Default:0
Example:offset=10
sortArray of strings

Sorting criteria in the format field,ASC or field,DESC. Can be repeated to apply multi-level sorting.

Example:sort=id,DESC&sort=name,ASC
nullOrderingstring

Specifies how NULL values are sorted. Options: NULLS_FIRST or NULLS_LAST. Default is NULLS_FIRST.

Default:"NULLS_FIRST"
Enum:"NULLS_FIRST""NULLS_LAST"
Example:nullOrdering=NULLS_LAST
curl -i -X GET \
  -u '<username>:<password>' \
  'https://awesome-company.calamari.io/api/people/v2?contractTypes=41d2e841-7f1f-4545-be09-8a17606f0228%2C31d2e841-7f1f-4545-be09-8a17606f0228&positions=1%2C2%2C3%2C4&teams=1%2C2%2C3%2C7%2C8&archived=true&projection=CUSTOM&fields=firstName%2ClastName%2Cemail&limit=50&offset=10&sort=id%2CDESC%2Cname%2CASC&nullOrdering=NULLS_LAST'

Responses

The request was successful. A list of people matching the specified criteria is returned.

Bodyapplication/json
dataArray of objects(SinglePersonResponseSchema)required

Collection of items.

metaobjectrequired

Collection of items.

Response
{
  "data": [
    { … }
  ],
  "meta": {
    "limit": 0,
    "offset": 0,
    "total": 0
  }
}