Shape Employees
Get a list of employees shaped according to the provided shape body. Supports cursor-based pagination, filtering, and ordering.
Full shape language reference (concepts, every directive, examples for
@property, $id, $inserted_at, $updated_at, $all, the $field
spec ($at / $type / $coerce / $on_error), $relation blocks,
@custom_properties.<key> references, and the $historical block with
$valid_from_field / $valid_to_field):
/platform/other/data-shape.
The at query parameter sets a request-level “as of” date for flat
field resolution; a root $at in the shape body overrides it, and a
per-field $at overrides both. Failed $type coercions are reported in
the response warnings array (the request still returns 200).
Returns 400 for any shape parsing problem, 403 when the role lacks
access to the employee resource or when the shape references a field
outside the role’s authorized field set.
Note: This operation is experimental and may change in the future.
Authorizations
Bearer token for authentication
Query Parameters
Request-level 'as of' date (ISO 8601) for flat field resolution.
Cursor pagination
Filter parameters for Employee Parameters for Employee filtering
Parameters for Employee ordering
Body
ShapeRequest
Inline shape describing how employee data should be projected. Full reference: /platform/other/data-shape.
Shape body. See /platform/other/data-shape for the full language reference.
Response
Employee list Response
A paginated list of shaped employees