Shape Employees

curl --request POST \
  --url https://api.twine.se/v1/org/employees/shape \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --data '{
  "shape": {}
}'

{
  "data": [
    {}
  ],
  "pagination": {
    "end_cursor": "<string>",
    "has_next_page": true,
    "has_previous_page": true,
    "start_cursor": "<string>"
  }
}

Employees

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, and the $historical block with $valid_from_field / $valid_to_field): /platform/other/data-shape.

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.

POST

org

employees

shape

Shape Employees

curl --request POST \
  --url https://api.twine.se/v1/org/employees/shape \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --data '{
  "shape": {}
}'

{
  "data": [
    {}
  ],
  "pagination": {
    "end_cursor": "<string>",
    "has_next_page": true,
    "has_previous_page": true,
    "start_cursor": "<string>"
  }
}

Authorizations

Authorization

string

header

required

Bearer token for authentication

Query Parameters

pagination

CursorPagination · object

Cursor pagination

Show child attributes

filters

EmployeeFilter · object

Filter parameters for Employee Parameters for Employee filtering

Show child attributes

order

EmployeeOrder · object

Parameters for Employee ordering

Show child attributes

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

Show child attributes

Create Employee Get Employee