EmployeePlacement
List EmployeePlacements
Returns a paginated list of all EmployeePlacements in your organization.
get/employee-placement
Query parameters
limitinteger
Example:1
The maximum number of EmployeePlacements to return (default: 50) when listing EmployeePlacements
offsetinteger
The number of EmployeePlacements to skip before starting to return results (default: 0) when listing EmployeePlacements
Response
Response for EmployeePlacement List operation - returns a paginated list of EmployeePlacement
Example response
{
"data": [
{
"id": "123e4567-e89b-12d3-a456-426614174000",
"meta": {
"createdAt": "2024-01-15T10:30:00Z",
"createdBy": "987fcdeb-51a2-43d1-b567-123456789abc",
"updatedAt": "2024-01-15T14:45:00Z",
"updatedBy": "987fcdeb-51a2-43d1-b567-123456789abc"
},
"external": {
"sourceID": "12345678",
"source": "ExternalIntegrationAPI"
},
"employeeID": "123e4567-e89b-12d3-a456-426614174000",
"schoolID": "123e4567-e89b-12d3-a456-426614174000",
"signature": "LM",
"title": "Principal",
"roles": [
"Admin"
],
"startDate": "2024-08-01",
"endDate": "2024-08-01",
"archiveYear": "2024_2025",
"archivedAt": "2024-08-01T00:00:00Z",
"employmentPercent": 100
}
],
"pagination": {
"limit": 1,
"total": 100
}
}