Go Headless

Build Apps

Client

API Preview

Develop Websites

REST

Velo

GraphQL (Alpha)

# About the Wix Bookings Attendance API


With the Wix Bookings Attendance API,  you can retrieve and manage a booked session's attendance information by: 

* [Setting](https://dev.wix.com/api/rest/wix-bookings/attendance/set-attendance) the attendance for a given booked session.
* [Getting](https://dev.wix.com/api/rest/wix-bookings/attendance/get-attendance) the attendance information for a given booked session by ID.
* [Querying](https://dev.wix.com/api/rest/wix-bookings/attendance/query-attendance) the attendance by given filters, sorting, and paging.

## About the attendance object

The [attendance object](https://dev.wix.com/api/rest/wix-bookings/attendance/attendance-object) holds information about the attendance of a booked session, such as: 
* Did anyone attend the session? 
* How many people attended the session?

The number of session `Attendance` objects available depends on session types:  
+ Appointment sessions have 1 `Attendance` object per appointment.
+ Class sessions have an `Attendance` object for each session of the class. The number of sessions for a class is defined in Schedule and Sessions' [`schedule.capacity`](https://dev.wix.com/api/rest/wix-bookings/schedules-and-sessions/schedule/schedule-object) property.
+ Course sessions have an `Attendance` object for each session of the course. The number of sessions for a class is defined in Schedule and Sessions' [`schedule.capacity`](https://dev.wix.com/api/rest/wix-bookings/schedules-and-sessions/schedule/schedule-object) property.


## Use cases

Common business usages for this API include:

* Set the attendance for a given booked session to reflect how many attendees checked in.
* Query the attendance for a given participant in a course booking.
* Query attendance for a particular booking's sessions over time to see if a particular session has frequent no-shows. You can compare the number of attendees to the number of participants that signed up for that booking's sessions. 

## Terminology

For a comprehensive glossary of Wix Bookings terms, see [Terminology](https://dev.wix.com/api/rest/wix-bookings/terminology).


## Before you begin

Validation capabilities are limited. Make sure your code validates that: 
+ There is no mismatch between `numberOfAttendees` and `attendanceStatus` to make sure, for example, that `attendanceStatus` is not `NOT_ATTENDED` while `numberOfAttendees` is `5`. 
+ The attendance's `numberOfAttendees` and the booking's `numberOfParticipants` correspond. For example, the number of attendees usually should not exceed the booking's intended number of participants (unless perhaps you allow walk-ins that did not sign up in advance).

# Supported Filters and Sorting


[Query Attendance](https://dev.wix.com/api/rest/wix-bookings/attendance/query-attendance) runs with these defaults:

+ sorted by `id` in `ASC` order
+ cursorPaging.limit is `50`

The following table shows field support for filters for the `Attendance` object:


| Field             | Supported Filters                                                     | Sortable  |
|-------------------|-----------------------------------------------------------------------| --------- |
| `id`                | `$eq`, `$ne`, `$in`, `$nin`, `$hasSome`                               | Sortable |
| `bookingId`         | `$eq`, `$ne`, `$in`, `$nin`, `$hasSome`                               | Sortable |
| `sessionId`         | `$eq`, `$ne`, `$in`, `$nin`, `$hasSome`                               | Sortable |
| `status`            | `$eq`, `$ne`, `$in`, `$nin`, `$hasSome`                               | Sortable |
| `numberOfAttendees` | `$eq`, `$ne`, `$in`, `$nin`, `$hasSome`, `$lt`, `$lte`, `$gt`, `$gte` | Sortable |


> **Notes:**
> + Only 1 filter is supported per query. If you define multiple filters in the same query, only the first is processed.



To learn about working with query endpoints, see
[API Query Language](https://dev.wix.com/api/rest/getting-started/api-query-language),
[Sorting and Paging](https://dev.wix.com/api/rest/getting-started/sorting-and-paging),
and [Field Projection](https://dev.wix.com/api/rest/getting-started/field-projection).

The `Attendance` object represents the attendance information
for a booked session, such as:

+ Did anyone attend the session?
+ How many people attended the session?

The number of session `Attendance` objects available depends on the booking type:
+ Appointment bookings have 1 `Attendance` object per appointment session.
+ Class bookings have 1 `Attendance` object for each session of the class. The number of sessions for a class is defined in Schedule and Sessions [`schedule.capacity`](https://dev.wix.com/api/rest/wix-bookings/schedules-and-sessions/schedule/schedule-object) property.
+ Course bookings have an `Attendance` object for each session of the course. For example, if there are 12 sessions in a course, there are 12 `Attendance` objects. The number of sessions for a class is defined in Schedule and Sessions [`schedule.capacity`](https://dev.wix.com/api/rest/wix-bookings/schedules-and-sessions/schedule/schedule-object) property.

bookingId

Total number of participants that attended the session. By default, the number
of attendees is set to `1`, but you can set a number to greater than `1` if multiple
participants attended.

Do not set to `0` to indicate that no one attended the session. Instead, set the `status` field to `NOT_ATTENDED`.

Default: 1

numberOfAttendees

sessionId

Status indicating if any particpants attended the session:

+ `NOT_SET`: There is no available attendance information.
+ `ATTENDED`: At least a single participant attended the session.
+ `NOT_ATTENDED`: No participants attended the session.

status

Attendance

AttendanceStatus

ID of the object that contains the attendance information that you want to retrieve.

attendanceId

GetAttendanceRequest

The retrieved attendance information for the booked session.

GetAttendanceResponse

QueryAttendanceRequest

List of objects that contain attendance information.

List of objects that contain attendance information for a booked session.

attendances

Details on the paged set of results returned.

QueryAttendanceResponse

The attendance information for a booked session that you want to create or update.

SetAttendanceRequest

The created or updated attendance information for the booked session.

SetAttendanceResponse

Pointer to the next or previous page in the list of results.

You can get the relevant cursor token
from the `pagingMetadata` object in the previous call's response.

Not relevant for the first request.

cursor

Number of `Attendance` objects to return.

Default: `50`
Maximum: `1000`

limit

CursorPaging

This is the preferred message for cursor-paging enabled services

Use these cursors to paginate between results. [Read more](https://dev.wix.com/api/rest/getting-started/api-query-language#getting-started_api-query-language_cursor-paging).

Indicates if there are more results after the current page.
If `true`, another page of results can be retrieved.
If `false`, this is the last page.

hasNext

CursorPagingMetadata

Cursor pointing to next page in the list of results.

Cursors

Filter object. See [API Query Language](https://dev.wix.com/api/rest/getting-started/api-query-language) for more information.

For a detailed list of supported fields and operators, see [Supported Filters and Sorting](https://dev.wix.com/api/rest/wix-bookings/attendance/supported-filters).

Max: 1 filter

filter

Sort object in the following format:
`[ {"fieldName":"sortField1","order":"ASC"}, {"fieldName":"sortField2","order":"DESC"} ]`

For details about sorting, see [Supported Filters and Sorting](https://dev.wix.com/api/rest/wix-bookings/attendance/supported-filters).

sort

QueryV2

Cursors to navigate through the result pages using `next` and `prev`.

pagingMethod

Sort order. Use `ASC` for ascending order or `DESC` for descending order.

Default: `ASC`.

SortOrder

fieldName

order

Sorting

value

BoolValue

Int32Value

values

ListValue

NullValue

StringValue

fields

Struct

Value

boolValue

listValue

nullValue

numberValue

stringValue

structValue

kind

Number of items to skip in the current sort order.

offset

Paging

Read Bookings - Including Participants

Retrieve attendance information for a booked session by attendance ID.

Retrieve attendance information

GetAttendance

Sets information about whether a booking's session was attended. This information
is saved in an `Attendance` object.


If attendance was already set, meaning the `Attendance` object already exists, the
existing attendance information is updated. Otherwise, a new `Attendance` object
is created.

By default, the number
of attendees is set to `1`, but you can set a number to greater than `1` if multiple
participants attended. Do not set to `0` to indicate that no one attended the session.
Instead, set the `status` field to `NOT_ATTENDED`.

> __Note:__ Make sure your code validates that:
>  + There is no mismatch between `numberOfAttendees` and `attendanceStatus` to make sure, for example, that `attendanceStatus` is not `NOT_ATTENDED` while `numberOfAttendees` is `5`.
>  + The attendance's `numberOfAttendees` and the booking's `numberOfParticipants` correspond. For example, the number of attendees usually should not exceed the booking's intended number of participants (unless perhaps you allow walk-ins that did not sign up in advance).

Manage Bookings

Mark a booked session as attended

SetAttendance

Whether a session is attended is determined by the `status` field, and not by the `number_of_attendees` field.

Mark a booked session as not attended

Retrieves attendance information for booked sessions, given the provided paging, filtering, and sorting.


When querying attendance information, you can query from the perspective of:
+ **A booking.** Specify a booking ID to retrieve attendance information
for all sessions related to that booking.
+ **A session.** Specify a session ID to  retrieve attendance information
for all bookings related to that session.

For example, query by a course's `bookingId` and `status = "NOT_ATTENDED"` to
retrieve the attendance of a given participant in a course. For example, this query
helps you determine if a participant booked the course
but did not attend most of its sessions, taking away spots for other potential participants.

Query Attendance runs with the following defaults, which you can override:

- `id` sorted in `ASC` order
- `cursorPaging.limit` is `50`

For field support, see [supported filters](https://dev.wix.com/api/rest/wix-bookings/attendance/supported-filters).

> __Notes__:
> + Another way to retrieve attendance information is to call Bookings Reader V2's [Query Extended Bookings](https://dev.wix.com/api/rest/wix-bookings/bookings-reader-v2/query-extended-bookings) with `withBookingAttendanceInfo` as `true`.
> + Up to 100 results can be returned per request.
> + Only 1 filter is supported per query. If you define multiple filters in the same query, only the first is processed.

To learn about working with query endpoints, see
[API Query Language](https://dev.wix.com/api/rest/getting-started/api-query-language).

Retrieves information about sessions that were not attended.

Get Attendance

Permission Scopes