Skip to main content
POST
Shape Employees

Authorizations

Authorization
string
header
required

Bearer token for authentication

Query Parameters

at
string<date>

Request-level 'as of' date (ISO 8601) for flat field resolution.

pagination
CursorPagination · object

Bracket syntax, one key per field: pagination[first]=50, then pagination[first]=50&pagination[after]=<end_cursor> for the next page.

Cursor pagination

filters
EmployeeFilter · object

Filter parameters for Employee

Bracket syntax, two keys per filtered field: filters[<field>][op]=<op>&filters[<field>][value]=<value>, e.g. filters[updated_at][op]=gt&filters[updated_at][value]=2026-01-01T00:00:00Z. Combine fields by adding more keys; every filter must match.

With op=in, separate the values with commas: filters[id][op]=in&filters[id][value]=<uuid>,<uuid>. filters[id][value][]=<uuid>&filters[id][value][]=<uuid> is accepted too.

Parameters for Employee filtering

order
EmployeeOrder · object

Bracket syntax: order[field]=<field>&order[direction]=desc. Parameters for Employee ordering

condition_id
string<uuid>

Id of an organization-wide condition (see GET /v1/org/conditions) whose domain is employee. Only records the condition passes are returned; filters still apply first. Record properties are encrypted at rest, so the condition runs in the application after the page is read and decrypted: a page may be shorter than first, even empty, while has_next_page is still true. Keep paging until has_next_page is false. pagination[last] / pagination[before] are not supported together with a condition. An unknown id or a condition of another domain is a 400. No permission on conditions is needed to filter by one; list on this resource is enough.

Body

application/json

ShapeRequest

Inline shape describing how employee data should be projected. Full reference: /platform/other/data-shape.

shape
object
required

Shape body. See /platform/other/data-shape for the full language reference.

Response

Employee list Response

A paginated list of shaped employees

data
object[]
required
pagination
CursorPaginationResult · object
required

Cursor pagination result

warnings
object[]

Type-validation warnings produced while shaping (failed $type coercions). Each entry carries employee_id, path, property, expected_type, value, and action.