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

Cursor pagination

filters
EmployeeFilter · object

Filter parameters for Employee Parameters for Employee filtering

order
EmployeeOrder · object

Parameters for Employee ordering

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.