Wonde API

https://docs.wonde.com/docs/api/
Admin
Wonde API is a school data management platform that allows you to retrieve and update school...
Tokens:161,068
Snippets:424
Trust Score:9.4
Update:7 months ago
Show doc for...
Tokens:
Raw
### Get Debtor Charges - API Request Examples

Source: https://docs.wonde.com/docs/api/sync

Examples of how to request debtor charges from the Wonde API using cURL. These requests require an API access token and specify the school ID. The second example shows how to retrieve a specific debtor charge by its ID.

```curl
curl "https://api.wonde.com/v1.0/schools/{school_id}/debtor-charges"
    -H "Authorization: Bearer API_ACCESS_TOKEN"

curl "https://api.wonde.com/v1.0/schools/{school_id}/debtor-charges/{debtor_charge_id}"
    -H "Authorization: Bearer API_ACCESS_TOKEN"
```

--------------------------------

### GET Intervention Sessions (cURL)

Source: https://docs.wonde.com/docs/api/sync

Examples of how to retrieve intervention sessions using cURL. This includes fetching all sessions for a school and retrieving a specific session by its ID. Requires an API access token for authorization.

```shell
curl "https://api.wonde.com/v1.0/schools/{school_id}/intervention/sessions"
    -H "Authorization: Bearer API_ACCESS_TOKEN"

curl "https://api.wonde.com/v1.0/schools/{school_id}/intervention/sessions/{intervention_session_id}"
    -H "Authorization: Bearer API_ACCESS_TOKEN"
```

--------------------------------

### Wonde Webhook Payload Examples

Source: https://docs.wonde.com/docs/api/sync

These JSON examples illustrate different payload types that can be received via Wonde webhooks. They include events like writebacks, school approvals, access revocations/declines, and school migrations, each with specific data relevant to the event.

```json
{
    "payload_type": "writeback",
    "writeback_id": "A2032141745",
    "status": "SUCCESS",
    "type": "attendance.session"
}
```

```json
{
    "payload_type": "schoolApproved",
    "school_id": "A2032141745",
    "school_name": "Sir John Cass's Foundation Primary School",
    "school_token": "7e76896f9aca62569048c667db292d72dd84f224",
    "school_la_code": "201",
    "school_urn": "10000",
    "school_establishment_number": "3614"
}
```

```json
{
    "payload_type": "accessRevoked",
    "school_id": "A2032141745",
    "school_name": "Sir John Cass's Foundation Primary School",
    "school_la_code": "201",
    "school_urn": "10000",
    "school_establishment_number": "3614",
    "revoke_reason": "Reason for revoking access"
}
```

```json
{
    "payload_type": "accessDeclined",
    "school_id": "A2032141745",
    "school_name": "Sir John Cass's Foundation Primary School",
    "school_la_code": "201",
    "school_urn": "10000",
    "school_establishment_number": "3614",
    "decline_reason": "Reason for declining access"
}
```

```json
{
    "payload_type": "schoolMigration",
    "school_id": "A2032141745",
    "school_name": "Sir John Cass's Foundation Primary School",
    "migrate_from": "SIMS",
    "migrate_to": "SIMS Primary",
    "scheduled_at": "2022-03-01T00:00:00.000Z",
    "completed_at": null
}
```

--------------------------------

### GET /schools/{school_id}/intervention/sessions

Source: https://docs.wonde.com/docs/api/sync

Retrieves a list of intervention sessions for a given school. Supports filtering by update time, session start time, and pagination.

```APIDOC
## GET /schools/{school_id}/intervention/sessions

### Description
Retrieves a list of intervention sessions for a given school. You can filter the results by modification date, session start date, and control the number of results per page. Related objects like interventions, students, and employees can also be included.

### Method
GET

### Endpoint
`/schools/{school_id}/intervention/sessions`

### Parameters
#### Path Parameters
- **school_id** (string) - Required - The unique identifier for the school.

#### Query Parameters
- **updated_after** (date) - Optional - Return rows modified after this date.
- **updated_before** (date) - Optional - Return rows modified before this date.
- **session_start_after** (date) - Optional - Return rows starting after this date.
- **session_start_before** (date) - Optional - Return rows starting before this date.
- **per_page** (int) - Optional - Amount of rows to return per page. Defaults to 50.
- **include** (string) - Optional - Comma-separated list of related objects to include (e.g., `intervention,students,employees`).

### Request Example
```bash
curl "https://api.wonde.com/v1.0/schools/{school_id}/intervention/sessions?include=intervention,students"
    -H "Authorization: Bearer API_ACCESS_TOKEN"
```

### Response
#### Success Response (200)
- **data** (array) - An array of intervention session objects.
- **meta** (object) - Metadata including pagination information and included objects.

#### Response Example
```json
{
    "data": [
        {
            "id": "A749126874",
            "mis_id": "17",
            "intervention": "A1167522173",
            "start_at": {
                "date": "2025-02-22 09:15:00.000000",
                "timezone_type": 3,
                "timezone": "UTC"
            },
            "end_at": {
                "date": "2025-04-22 10:15:00.000000",
                "timezone_type": 3,
                "timezone": "UTC"
            },
            "created_at": {
                "date": "2025-02-08 11:25:28.000000",
                "timezone_type": 3,
                "timezone": "UTC"
            },
            "updated_at": {
                "date": "2025-02-08 11:25:28.000000",
                "timezone_type": 3,
                "timezone": "UTC"
            },
            "restored_at": {
                "date": "2025-02-08 11:25:28.000000",
                "timezone_type": 3,
                "timezone": "UTC"
            }
        }
    ],
    "meta": {
        "pagination": {
            "next": "https://api.wonde.com/v1.0/schools/A1329183376/intervention/sessions?page=2",
            "previous": null,
            "more": false,
            "per_page": 50,
            "current_page": 1
        },
        "includes": [
            "intervention",
            "intervention.subject",
            "students",
            "employees"
        ]
    }
}
```
```

--------------------------------

### Detention Type Object Example

Source: https://docs.wonde.com/docs/api/sync

This is an example of the JSON response body for a single detention type object. It details the properties of a detention, such as its ID, name, duration, start and end times, and the day of the week it occurs. It also includes timestamps for creation and last update.

```json
{
    "id": "A1329183376",
    "mis_id": "1",
    "name": "Monday Lunchtime",
    "duration_in_minutes": 30,
    "frequency_per_month": "A1664730745",
    "start_time": "12:30",
    "end_time": "13:00",
    "day_of_week": 1,
    "employee": "A2019555757",
    "room": "A688857193",
    "created_at": {
        "date": "2023-05-17 09:59:51.000000",
        "timezone_type": 3,
        "timezone": "UTC"
    },
    "updated_at": {
        "date": "2023-05-17 09:59:51.000000",
        "timezone_type": 3,
        "timezone": "UTC"
    }
}
```

--------------------------------

### POST Student Absences with Curl

Source: https://docs.wonde.com/docs/api/sync

Example of how to create a student absence record using a cURL command. This requires the 'student-absences.write' permission. The request includes student ID, start and end times, event type, absence type, and optional reason, comment, and authorised_by details.

```curl
curl -X POST -H "Authorization: Bearer API_ACCESS_TOKEN" -H "Content-Type: application/json" -d '{
    "absence": [
        {
            "student_id": "A1849765024",
            "start_at": "2018-01-29 08:00:00",
            "end_at": "2018-01-29 17:00:00",
            "event_type": "sign in",
            "absence_type": "Sickness",
            "reason": "School nurse",
            "comment": "Student caught flu.",
            "authorised_by": "A960618364"
        }
    ]}' "https://api.wonde.com/v1.0/schools/{school_id}/attendance/absence"
```

--------------------------------

### POST Student Absences Request Body Example

Source: https://docs.wonde.com/docs/api/sync

An example of the JSON request body used to create student absence records. It allows for multiple absence entries within a single request, each specifying student ID, time range, event type, absence type, and optional details.

```json
{
     "absence": [
         {
             "student_id": "A1849765024",
             "start_at": "2018-01-29 08:00:00",
             "end_at": "2018-01-29 17:00:00",
             "event_type": "sign in",
             "absence_type": "Sickness",
             "reason": "School nurse",
             "comment": "Student caught flu",
             "authorised_by": "A960618364"
         },
         {
             "student_id": "A1849765024",
             "start_at": "2018-01-29 08:00:00",
             "end_at": "2018-01-29 14:00:00",
             "event_type": "sign in",
             "absence_type": "Sickness",
             "reason": "School nurse",
             "comment": "Student caught flu",
             "authorised_by": "A960618364"
         }
     ]
 }
```

--------------------------------

### GET /students

Source: https://docs.wonde.com/docs/api/sync

Retrieves a list of students. Requires 'students read' permission.

```APIDOC
## GET /students

### Description
Retrieves a list of students. Requires 'students read' permission.

### Method
GET

### Endpoint
/students

### Parameters
#### Query Parameters
- **id** (string) - Optional - Filter students by ID.
- **upi** (string) - Optional - Filter students by Unique Person Identifier.
- **mis_id** (string) - Optional - Filter students by MIS ID.

### Request Example
```json
{
  "example": "GET /students?mis_id=9919"
}
```

### Response
#### Success Response (200)
- **id** (string) - The ID of the student.
- **upi** (string) - Unique Person Identifier.
- **mis_id** (string) - The student’s ID in the MIS.
- **initials** (string) - The student’s initials.
- **title** (string) - The student’s title.
- **surname** (string) - The student’s last name.
- **forename** (string) - The student’s first name.
- **middle_names** (string) - The student’s middle names.
- **legal_surname** (string) - The student’s legal last name.
- **legal_forename** (string) - The student’s legal first name.
- **gender** (string) - The student’s gender.
- **gender_identity** (string) - The student’s gender identity.
- **date_of_birth** (date) - The student’s date of birth.
- **restored_at** (datetime) - When the Wonde ID was restored from the deletions data.
- **created_at** (datetime) - When the record was added to Wonde.
- **updated_at** (datetime) - When the record was last updated on Wonde.

#### Response Example
```json
{
    "id": "A1749191433",
    "upi": "8d444684b7aa79bc97f8594a4aab7ce3",
    "mis_id": "9919",
    "initials": "TS",
    "title": "Mr",
    "surname": "Smith",
    "forename": "Tom",
    "middle_names": null,
    "legal_surname": "Smith",
    "legal_forename": "Tom",
    "gender": "MALE",
    "gender_identity": null,
    "date_of_birth": {
        "date": "2002-09-29 00:00:00.000000",
        "timezone_type": 3,
        "timezone": "Europe/London"
    },
    "restored_at": {
        "date": "2002-09-29 00:00:00.000000",
        "timezone_type": 3,
        "timezone": "Europe/London"
    },
    "created_at": {
        "date": "2016-07-14 10:26:12.000000",
        "timezone_type": 3,
        "timezone": "UTC"
    },
    "updated_at": {
        "date": "2016-07-15 09:59:05.000000",
        "timezone_type": 3,
        "timezone": "UTC"
    }
}
```
```

--------------------------------

### GET /websites/wonde_api/behaviour

Source: https://docs.wonde.com/docs/api/sync

Retrieves a Behaviour object. Requires 'behaviour read' permission.

```APIDOC
## GET /websites/wonde_api/behaviour

### Description
Retrieves details of a specific behaviour incident. This endpoint requires the 'behaviour read' permission.

### Method
GET

### Endpoint
/websites/wonde_api/behaviour

### Parameters
#### Query Parameters
- **id** (string) - Required - The unique identifier of the behaviour incident.

### Response
#### Success Response (200)
- **id** (string) - The ID of the object.
- **mis_id** (string) - The ID in the MIS.
- **type** (string) - The type of behaviour incident.
- **location** (string) - The location of the incident.
- **subject** (string) - The subject during which the incident occurred.
- **class** (string) - The class in which the incident occurred.
- **status** (string) - The status of the incident.
- **action** (string) - The action taken in response to the incident.
- **points** (integer) - The amount of points associated to the incident.
- **total_points** (integer) - The total amount of points associated to the incident.
- **comment** (string) - Short text note.
- **parents_notified** (boolean) - Boolean indicating if a parent has been notified of the incident.
- **bullying_type** (string) - Bullying type.
- **incident_date** (string) - The date the incident took place.
- **action_date** (datetime) - The date action was taken.
- **recorded_date** (datetime) - The date the incident was recorded.
- **created_at** (datetime) - When the record was added to Wonde.
- **updated_at** (datetime) - When the record was last updated on Wonde.

#### Response Example
```json
{
    "id": "A1329183376",
    "mis_id": "263",
    "type": "Homework Issue",
    "location": "Science",
    "subject": "Science",
    "class": "7A/Science",
    "status": "Resolved",
    "action": "Lunchtime Detention",
    "points": 1,
    "total_points": 10,
    "comment": "Despite previous warnings, one of five students who still have significant homework from two weeks ago still outstanding.",
    "parents_notified": false,
    "bullying_type": "Bullying-Intimidation",
    "incident_date": {
        "date": "2009-04-29 00:00:00.000000",
        "timezone_type": 3,
        "timezone": "Europe/London"
    },
    "action_date": {
        "date": "2009-05-01 00:00:00.000000",
        "timezone_type": 3,
        "timezone": "Europe/London"
    },
    "recorded_date": {
        "date": "2009-04-29 00:00:00.000000",
        "timezone_type": 3,
        "timezone": "Europe/London"
    },
    "created_at": {
        "date": "2016-03-15 11:08:55.000000",
        "timezone_type": 3,
        "timezone": "UTC"
    },
    "updated_at": {
        "date": "2016-03-15 11:08:55.000000",
        "timezone_type": 3,
        "timezone": "UTC"
    }
}
```
```

--------------------------------

### GET Applied Permissions

Source: https://docs.wonde.com/docs/api/sync

Retrieves a list of permissions applied to a specific school.

```APIDOC
## GET Applied Permissions

### Description
Returns the permissions that are applied to a school.

### Method
GET

### Endpoint
/v1.0/meta/schools/{school_id}/permissions

### Parameters
#### Path Parameters
- **school_id** (string) - Required - The ID of the school.

#### Query Parameters
None

### Request Body
None

### Request Example
```json
{
  "example": ""
}
```

### Response
#### Success Response (200)
- **data** (array) - An array of permission objects.
  - **identity** (string) - The unique identifier for the permission.
  - **name** (string) - The display name of the permission.
  - **description** (string) - A description of what the permission allows.
  - **parent** (string|null) - The parent permission, if any.
  - **group** (string) - The group the permission belongs to.
  - **active_from** (object) - Information about when the permission became active.
    - **date** (string) - The date and time the permission became active.
    - **timezone_type** (integer) - The timezone type.
    - **timezone** (string) - The timezone.
  - **optional** (boolean) - Whether the permission is optional.
  - **approved** (boolean) - Whether the permission is approved.
  - **audited** (boolean) - Whether the permission is audited.

#### Response Example
```json
{
    "data": [
        {
            "identity": "students.read",
            "name": "Students read",
            "description": "View student data",
            "parent": null,
            "group": "Student",
            "active_from": {
                "date": "2018-02-01 15:32:20.000000",
                "timezone_type": 3,
                "timezone": "Europe/London"
            },
            "optional": true,
            "approved": true,
            "audited": false
        }
    ]
}
```
```

--------------------------------

### GET /schools/{school_id}/rooms/{room_id}

Source: https://docs.wonde.com/docs/api/sync

Retrieves a specific room by its ID for a given school.

```APIDOC
## GET /schools/{school_id}/rooms/{room_id}

### Description
Retrieves details for a specific room using its unique ID within a given school.

### Method
GET

### Endpoint
`/schools/{school_id}/rooms/{room_id}`

### Parameters
#### Path Parameters
- **school_id** (string) - Required - The ID of the school.
- **room_id** (string) - Required - The ID of the room to retrieve.

### Request Example
```json
{
  "example": "curl \"https://api.wonde.com/v1.0/schools/{school_id}/rooms/{room_id}\" \
    -H \"Authorization: Bearer API_ACCESS_TOKEN\""
}
```

### Response
#### Success Response (200)
- **id** (string) - The unique identifier for the room.
- **code** (string) - The room code.
- **name** (string) - The name of the room.
- **created_at** (datetime) - The timestamp when the record was added to Wonde.
- **updated_at** (datetime) - The timestamp when the record was last updated on Wonde.

#### Response Example
```json
{
    "id": "A1161584171",
    "code": "A2",
    "name": "Art Room 2",
    "created_at": {
        "date": "2015-10-29 10:27:44.000000",
        "timezone_type": 3,
        "timezone": "UTC"
    },
    "updated_at": {
        "date": "2015-10-29 10:27:44.000000",
        "timezone_type": 3,
        "timezone": "UTC"
    }
}
```
```

--------------------------------

### GET /students/{id}

Source: https://docs.wonde.com/docs/api/sync

Retrieves a specific student by their ID. Requires 'students read' permission.

```APIDOC
## GET /students/{id}

### Description
Retrieves a specific student by their ID. Requires 'students read' permission.

### Method
GET

### Endpoint
/students/{id}

### Parameters
#### Path Parameters
- **id** (string) - Required - The ID of the student to retrieve.

### Request Example
```json
{
  "example": "GET /students/A1749191433"
}
```

### Response
#### Success Response (200)
- **id** (string) - The ID of the student.
- **upi** (string) - Unique Person Identifier.
- **mis_id** (string) - The student’s ID in the MIS.
- **initials** (string) - The student’s initials.
- **title** (string) - The student’s title.
- **surname** (string) - The student’s last name.
- **forename** (string) - The student’s first name.
- **middle_names** (string) - The student’s middle names.
- **legal_surname** (string) - The student’s legal last name.
- **legal_forename** (string) - The student’s legal first name.
- **gender** (string) - The student’s gender.
- **gender_identity** (string) - The student’s gender identity.
- **date_of_birth** (date) - The student’s date of birth.
- **restored_at** (datetime) - When the Wonde ID was restored from the deletions data.
- **created_at** (datetime) - When the record was added to Wonde.
- **updated_at** (datetime) - When the record was last updated on Wonde.

#### Response Example
```json
{
    "id": "A1749191433",
    "upi": "8d444684b7aa79bc97f8594a4aab7ce3",
    "mis_id": "9919",
    "initials": "TS",
    "title": "Mr",
    "surname": "Smith",
    "forename": "Tom",
    "middle_names": null,
    "legal_surname": "Smith",
    "legal_forename": "Tom",
    "gender": "MALE",
    "gender_identity": null,
    "date_of_birth": {
        "date": "2002-09-29 00:00:00.000000",
        "timezone_type": 3,
        "timezone": "Europe/London"
    },
    "restored_at": {
        "date": "2002-09-29 00:00:00.000000",
        "timezone_type": 3,
        "timezone": "Europe/London"
    },
    "created_at": {
        "date": "2016-07-14 10:26:12.000000",
        "timezone_type": 3,
        "timezone": "UTC"
    },
    "updated_at": {
        "date": "2016-07-15 09:59:05.000000",
        "timezone_type": 3,
        "timezone": "UTC"
    }
}
```
```

--------------------------------

### Include Data Example (JSON)

Source: https://docs.wonde.com/docs/api/sync

Illustrates how to request additional properties in the API response using the 'includes' meta option. This allows for optimized performance by fetching only necessary data by default.

```JSON
{
    "meta": {
        "includes": [
            "contacts",
            "contacts.contact_details"
        ]
    }
}
```

--------------------------------

### Compression Enablement Example (cURL)

Source: https://docs.wonde.com/docs/api/sync

Shows how to enable gzip compression for API requests to reduce bandwidth usage. This is achieved by setting the 'Accept-Encoding' header.

```cURL
curl "https://api.wonde.com/v1.0/schools/all"
    -H "Accept-Encoding: gzip"
    -H "Authorization: Bearer API_ACCESS_TOKEN"
```

--------------------------------

### Cursor Pagination Example (cURL)

Source: https://docs.wonde.com/docs/api/sync

Shows how to enable and use cursor pagination for more efficient traversal of paginated API results. This method is recommended for data extraction when specific page jumping is not required.

```cURL
curl "https://api.wonde.com/v1.0/schools/{school_id}/students/?cursor=true"
    -H "Authorization: Bearer API_ACCESS_TOKEN"
```

--------------------------------

### Fetch Lessons using Curl

Source: https://docs.wonde.com/docs/api/sync

This snippet demonstrates how to fetch lesson data from the Wonde API using Curl. It shows examples for retrieving all lessons for a school and a specific lesson by its ID. Ensure you replace placeholders with your actual school ID and API access token.

```bash
curl "https://api.wonde.com/v1.0/schools/{school_id}/lessons"
    -H "Authorization: Bearer API_ACCESS_TOKEN"

curl "https://api.wonde.com/v1.0/schools/{school_id}/lessons/{lesson_id}"
    -H "Authorization: Bearer API_ACCESS_TOKEN"
```

--------------------------------

### Student Absence Object Response Body Example

Source: https://docs.wonde.com/docs/api/sync

An example of the JSON response body representing a single student absence record. This object includes details such as the absence ID, student ID, event type, start and end times, absence type, reason, and authorization information. Requires 'student-absences.read' permission to view.

```json
{
    "id": "A1744353885",
    "mis_id": "0sfo4-wfer-r3gg23-nm762ca-098j",
    "student": "A7639428573",
    "event_type": "sign in",
    "start_at": {
        "date": "2016-08-02 08:30:00.000000",
        "timezone_type": 3,
        "timezone": "Europe/London"
    },
    "end_at": {
        "date": "2016-08-02 09:30:00.000000",
        "timezone_type": 3,
        "timezone": "Europe/London"
    },
    "absence_type": "Justified with school policy",
    "reason": "School Nurse",
    "comment": "Sickness",
    "authorised_by": "A8294679863",
    "created_at": {
        "date": "2016-08-06 09:14:51.000000",
        "timezone_type": 3,
        "timezone": "UTC"
    },
    "updated_at": {
        "date": "2016-08-06 09:14:51.000000",
        "timezone_type": 3,
        "timezone": "UTC"
    }
}
```

--------------------------------

### Offset Pagination Example (cURL)

Source: https://docs.wonde.com/docs/api/sync

Demonstrates how to use offset pagination to retrieve a specific page of results from the Wonde API. This method is the default but can become slower for deeper page traversals.

```cURL
curl "https://api.wonde.com/v1.0/schools/{school_id}/students/?page=1"
    -H "Authorization: Bearer API_ACCESS_TOKEN"
```

--------------------------------

### Get Student Absences (Curl)

Source: https://docs.wonde.com/docs/api/sync

This section provides Curl examples for fetching student absence data from the Wonde API. It shows how to retrieve all absences for a school or a specific student absence by its ID.

```curl
curl "https://api.wonde.com/v1.0/schools/{school_id}/attendance/absence"
    -H "Authorization: Bearer API_ACCESS_TOKEN"
```

```curl
curl "https://api.wonde.com/v1.0/schools/{school_id}/attendance/absence/{student_absence}"
    -H "Authorization: Bearer API_ACCESS_TOKEN"
```

--------------------------------

### Compression

Source: https://docs.wonde.com/docs/api/sync

Enable gzip compression by including the `Accept-Encoding: gzip` header in your request to reduce bandwidth usage.

```APIDOC
## Request with Compression

### Description
Enables gzip compression for API responses to reduce bandwidth usage.

### Method
GET

### Endpoint
`/schools/all` (Example endpoint)

### Headers
- **Accept-Encoding**: `gzip`
- **Authorization**: `Bearer API_ACCESS_TOKEN`

### Request Example
```
curl "https://api.wonde.com/v1.0/schools/all"
    -H "Accept-Encoding: gzip"
    -H "Authorization: Bearer API_ACCESS_TOKEN"
```
```

--------------------------------

### Date Filtering Example (cURL)

Source: https://docs.wonde.com/docs/api/sync

Demonstrates how to filter API results based on update dates using `updated_after` and `updated_before` parameters. Dates must be provided in ISO format.

```cURL
curl "https://api.wonde.com/v1.0/schools/{school_id}/students?updated_after=2026-01-05 01:01:17&updated_before=2026-01-13 12:01:00"
    -H "Authorization: Bearer API_ACCESS_TOKEN"
```

--------------------------------

### Get Events - Curl

Source: https://docs.wonde.com/docs/api/sync

Retrieves a list of events for a school or a specific event by its ID. Requires appropriate read permissions. The response contains event details such as description, start and end times, and creation/update timestamps.

```curl
curl "https://api.wonde.com/v1.0/schools/{school_id}/events"
    -H "Authorization: Bearer API_ACCESS_TOKEN"

    curl "https://api.wonde.com/v1.0/schools/{school_id}/events/{event_id}"
    -H "Authorization: Bearer API_ACCESS_TOKEN"
```

--------------------------------

### GET Session Attendance Request (cURL)

Source: https://docs.wonde.com/docs/api/sync

Example cURL command to retrieve session attendance data for a school. Requires an API access token and the school ID. Supports filtering by date, student, and update time.

```curl
curl "https://api.wonde.com/v1.0/schools/{school_id}/attendance/session"
    -H "Authorization: Bearer API_ACCESS_TOKEN"
```

--------------------------------

### Includes

Source: https://docs.wonde.com/docs/api/sync

By default, responses contain only basic properties. Use the `include` parameter to request additional properties for optimized performance.

```APIDOC
## GET /resource

### Description
Retrieves resource data, with options to include additional related properties.

### Method
GET

### Endpoint
`/resource`

### Query Parameters
- **include** (string) - Optional - Comma-separated list of additional properties to include (e.g., `contacts,contacts.contact_details`). Available options are specified in the meta data of a request.

### Response
#### Success Response (200)
- **meta** (object) - Contains metadata about the response.
  - **includes** (array) - List of included properties.

#### Response Example
```json
{
    "meta": {
        "includes": [
            "contacts",
            "contacts.contact_details"
        ]
    }
}
```
```

--------------------------------

### GET /schools/{school_id}/employees

Source: https://docs.wonde.com/docs/api/sync

Retrieves a list of employees for a specific school. Supports filtering by update time, employment start date, roles, contracts, groups, and user-defined fields. It also allows for including related data and paginating results.

```APIDOC
## GET /schools/{school_id}/employees

### Description
Retrieves a list of employees for a specific school. This endpoint allows for filtering by various criteria such as update times, employment start dates, roles, contracts, groups, and user-defined fields. You can also specify related data to be included in the response and control the pagination of results.

### Method
GET

### Endpoint
`/schools/{school_id}/employees`

### Parameters
#### Path Parameters
- **school_id** (string) - Required - The unique identifier for the school.

#### Query Parameters
- **updated_after** (date) - Optional - Return rows modified after this date.
- **updated_before** (date) - Optional - Return rows modified before this date.
- **per_page** (int) - Optional - Amount of rows to return per page.
- **include** (string) - Optional - Comma-separated list of objects to include in the response (e.g., `contact_details`, `employment_details`).
- **employment_start_before** (date) - Optional - Get employees who started employment before this date.
- **employment_start_after** (date) - Optional - Get employees who started employment after this date.
- **has_role** (any) - Optional - Filter to only return employees who have a role.
- **has_contract** (any) - Optional - Filter to only return employees who have a contract.
- **has_class** (any) - Optional - Filter to only return employees who have one or more classes.
- **has_group** (any) - Optional - Filter to only return employees who have one or more groups.
- **user_defined_field** (string) - Optional - Filter employees by a specific user-defined field key.
- **only_user_defined_fields** (string) - Optional - Filter user-defined fields by a comma-separated list of keys.
- **only_mis_ids** (string) - Optional - Filter by a comma-separated list of MIS IDs.

### Request Example
```bash
curl "https://api.wonde.com/v1.0/schools/{school_id}/employees?include=contact_details,roles&updated_after=2023-01-01"
    -H "Authorization: Bearer API_ACCESS_TOKEN"
```

### Response
#### Success Response (200)
- **data** (array) - An array of employee objects.
  - **id** (string) - The unique identifier for the employee.
  - **upi** (string) - The Universal Personal Identifier.
  - **mis_id** (string) - The Management Information System ID.
  - **title** (string) - The employee's title (e.g., 'Mr', 'Mrs').
  - **initials** (string) - The employee's initials.
  - **surname** (string) - The employee's surname.
  - **forename** (string) - The employee's forename.
  - **middle_names** (string|null) - The employee's middle names, if any.
  - **legal_surname** (string) - The employee's legal surname.
  - **legal_forename** (string) - The employee's legal forename.
  - **gender** (string) - The employee's gender.
  - **date_of_birth** (object) - The employee's date of birth, including timezone information.
  - **restored_at** (object) - Timestamp when the employee record was restored.
  - **updated_at** (object) - Timestamp when the employee record was last updated.
  - **created_at** (object) - Timestamp when the employee record was created.
- **meta** (object) - Metadata about the response, including pagination details and available includes.
  - **pagination** (object) - Pagination information (next, previous, more, per_page, current_page).
  - **includes** (array) - A list of data objects that can be included in the response.

#### Response Example
```json
{
    "data": [
        {
            "id": "A1329183376",
            "upi": "5cc4ab015f8f7870b581e30e0ef474fa",
            "mis_id": "26",
            "title": "Mrs",
            "initials": "SS",
            "surname": "Smith",
            "forename": "Sally",
            "middle_names": null,
            "legal_surname": "Smith",
            "legal_forename": "Sally",
            "gender": "female",
            "date_of_birth": {
                "date": "1963-02-11 00:00:00.000000",
                "timezone_type": 3,
                "timezone": "Europe/London"
            },
            "restored_at": {
                "date": "2015-10-29 14:59:08.000000",
                "timezone_type": 3,
                "timezone": "UTC"
            },
            "updated_at": {
                "date": "2015-10-29 14:59:08.000000",
                "timezone_type": 3,
                "timezone": "UTC"
            },
            "created_at": {
                "date": "2015-10-29 14:45:00.000000",
                "timezone_type": 3,
                "timezone": "UTC"
            }
        }
    ],
    "meta": {
        "pagination": {
            "next": "https://api.wonde.com/v1.0/schools/{school_id}/employees/?page=2",
            "previous": null,
            "more": true,
            "per_page": "2",
            "current_page": 1
        },
        "includes": [
            "contact_details",
            "employment_details",
            "extended_details",
            "roles",
            "allowances",
            "scales",
            "photo",
            "roles.contract",
            "allowances.contract",
            "scales.contract",
            "contracts",
            "contracts.roles",
            "contracts.salary",
            "contracts.salary.allowances",
            "contracts.salary.scales",
            "salary",
            "salary.contract",
            "groups",
            "campus",
            "classes",
            "employee_absences",
            "identifiers",
            "user_defined_fields",
            "next_of_kin"
        ]
    }
}
```
```

--------------------------------

### GET /schools/{school_id}/lessons

Source: https://docs.wonde.com/docs/api/sync

Retrieves a list of lessons for a specific school. This endpoint returns data for only one academic week at a time, even when using the 'lessons_start_after' parameter. You can include related objects like 'employee' or 'employees' for more detailed information.

```APIDOC
## GET /schools/{school_id}/lessons

### Description
Retrieves a list of lessons for a specific school. This endpoint returns data for only one academic week at a time. You can include related objects like 'employee' or 'employees' for more detailed information.

### Method
GET

### Endpoint
/schools/{school_id}/lessons

### Parameters
#### Path Parameters
- **school_id** (string) - Required - The ID of the school.

#### Query Parameters
- **updated_after** (date) - Optional - Return rows modified after this date.
- **updated_before** (date) - Optional - Return rows modified before this date.
- **lessons_start_after** (date) - Optional - Return rows starting after this date. Note: Only returns data for the academic week of the specified date.
- **lessons_start_before** (date) - Optional - Return rows starting before this date.
- **per_page** (int) - Optional - Amount of rows to return per page. Defaults to 50.
- **include** (string) - Optional - Comma-separated list of objects to include (e.g., 'employee', 'employees', 'class', 'period', 'room').

### Request Example
```bash
curl "https://api.wonde.com/v1.0/schools/{school_id}/lessons?include=employee"
    -H "Authorization: Bearer API_ACCESS_TOKEN"
```

### Response
#### Success Response (200)
- **data** (array) - An array of lesson objects.
- **meta** (object) - Contains metadata about the response, including pagination and available includes.

##### Lesson Object
- **id** (string) - The unique identifier for the lesson.
- **room** (string) - The ID of the room where the lesson is taught (nullable).
- **period** (string) - The ID of the period the lesson occurs during (nullable).
- **employee_id** (string) - The ID of the main class teacher for this lesson (nullable).
- **period_instance_id** (int) - Identifier for all lessons occurring during the same period instance.
- **alternative** (boolean) - Indicates if the lesson is an alternative to another lesson.
- **start_at** (datetime) - The start time of the lesson.
- **end_at** (datetime) - The end time of the lesson.
- **created_at** (datetime) - The timestamp when the record was added to Wonde.
- **updated_at** (datetime) - The timestamp when the record was last updated on Wonde.

#### Response Example
```json
{
    "data": [
        {
            "id": "A749126774",
            "room": "A1161584171",
            "period": "A1161584171",
            "period_instance_id": "40860",
            "employee": null,
            "start_at": {
                "date": "2016-02-22 09:15:00.000000",
                "timezone_type": 3,
                "timezone": "UTC"
            },
            "end_at": {
                "date": "2016-02-22 10:15:00.000000",
                "timezone_type": 3,
                "timezone": "UTC"
            },
            "created_at": {
                "date": "2016-02-08 11:25:28.000000",
                "timezone_type": 3,
                "timezone": "UTC"
            },
            "updated_at": {
                "date": "2016-02-08 11:25:28.000000",
                "timezone_type": 3,
                "timezone": "UTC"
            }
        }
    ],
    "meta": {
        "pagination": {
            "next": "https://api.wonde.com/v1.0/schools/A1329183376/lessons?page=2",
            "previous": null,
            "more": true,
            "per_page": 50,
            "current_page": 1
        },
        "includes": [
            "class",
            "employee",
            "employees",
            "period",
            "room"
        ]
    }
}
```
```

--------------------------------

### Wonde API Authentication Examples (cURL)

Source: https://docs.wonde.com/docs/api/sync

Demonstrates two methods for authenticating with the Wonde API using cURL: bearer token and basic authentication. The bearer token method is preferred for security. Basic authentication requires the access token as the username and an empty password.

```cURL
curl https://api.wonde.com/v1.0 \
    -u 7e76896f9aca62569048c667db292d72dd84f224:
```

```cURL
curl https://api.wonde.com/v1.0 \
    -H "Authorization: Bearer 7e76896f9aca62569048c667db292d72dd84f224"
```

--------------------------------

### Wonde API Events Object Response Body Example

Source: https://docs.wonde.com/docs/api/sync

This JSON object represents a single event record returned by the Wonde API. It includes details such as IDs, descriptions, start and end times, and timestamps for creation and updates. This structure is consistent across API responses for events.

```json
{
    "id": "A1529934786",
    "mis_id": "2345",
    "description": "Planned whole or partial school closure",
    "type": null,
    "start_at": {
        "date": "2016-08-31 00:00:00.000000",
        "timezone_type": 3,
        "timezone": "Europe/London"
    },
    "end_at": {
        "date": "2016-08-31 23:59:59.000000",
        "timezone_type": 3,
        "timezone": "Europe/London"
    },
    "created_at": {
        "date": "2016-07-14 10:26:12.000000",
        "timezone_type": 3,
        "timezone": "UTC"
    },
    "updated_at": {
        "date": "2016-07-15 09:59:05.000000",
        "timezone_type": 3,
        "timezone": "UTC"
    }
}
```
Tokens:
Raw