StudentPlacement
List StudentPlacements
Returns a paginated list of all StudentPlacements in your organization.
get/student-placement
Query parameters
limitinteger
Example:1
The maximum number of StudentPlacements to return (default: 50) when listing StudentPlacements
offsetinteger
The number of StudentPlacements to skip before starting to return results (default: 0) when listing StudentPlacements
Response
Response for StudentPlacement List operation - returns a paginated list of StudentPlacement
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"
},
"studentID": "123e4567-e89b-12d3-a456-426614174000",
"schoolID": "123e4567-e89b-12d3-a456-426614174000",
"schoolType": "GR",
"schoolYear": "1",
"hasChildcare": true,
"childcareMaxHours": 15,
"motherTongue": "SWE",
"modernLanguageAlternative": "EN",
"swedishAsSecondLanguage": false,
"motherTongueParticipates": false,
"modernLanguageInSchoolChoice": "deu",
"modernLanguageInLanguageChoice": "fra",
"startDate": "2024-08-01",
"endDate": "2025-08-01",
"archiveYear": "2024_2025",
"archivedAt": "2024-08-01T00:00:00Z"
}
],
"pagination": {
"limit": 1,
"total": 100
}
}