Go Headless

Build Apps

Client

API Preview

Develop Websites

REST

Velo

GraphQL (Alpha)

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

attendanceId

string

import { createClient, OAuthStrategy } from '@wix/sdk';
import { attendance } from '@wix/bookings';

const wixClient = createClient({
  modules: { attendance } ,
  auth: OAuthStrategy({ clientId: 'MY-CLIENT-ID' })
});

async function getAttendance(attendanceId) {
  const response = await wixClient.attendance.getAttendance(attendanceId);
}

getAttendance() with visitor/member access

import { createClient, ApiKeyStrategy } from '@wix/sdk';
import { attendance } from '@wix/bookings';

const wixClient = createClient({
  modules: { attendance },
  auth: ApiKeyStrategy({
    siteId: 'MY-SITE-ID',
    apiKey: 'MY-API-KEY'
  })
});

async function getAttendance(attendanceId) {
  const response = await wixClient.attendance.getAttendance(attendanceId);
}

getAttendance() with API Key access

import { createClient } from '@wix/sdk';
import { dashboard } from '@wix/dashboard';
import { attendance } from '@wix/bookings';

const wixClient = createClient({
  modules: { attendance },
  auth: dashboard.auth(),
  host: dashboard.host()
});

async function getAttendance(attendanceId) {
  const response = await wixClient.attendance.getAttendance(attendanceId);
}

getAttendance() with Dashboard app access

getAttendance

Attendance

The retrieved attendance information for the booked session.

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 `withBookingAttendanceDetails` 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).


|PROPERTY	|SUPPORTED FILTERS & SORTING	
|:---:|:---:|
|`_id`|[`eq()`](/attendance/attendances-query-builder/eq),[`ne()`](/attendance/attendances-query-builder/ne),[`in()`](/attendance/attendances-query-builder/in),[`ascending()`](/attendance/attendances-query-builder/ascending)|
|`bookingId`|[`eq()`](/attendance/attendances-query-builder/eq),[`ne()`](/attendance/attendances-query-builder/ne),[`in()`](/attendance/attendances-query-builder/in),[`ascending()`](/attendance/attendances-query-builder/ascending)|
|`sessionId`|[`eq()`](/attendance/attendances-query-builder/eq),[`ne()`](/attendance/attendances-query-builder/ne),[`in()`](/attendance/attendances-query-builder/in),[`ascending()`](/attendance/attendances-query-builder/ascending)|
|`status`|[`eq()`](/attendance/attendances-query-builder/eq),[`ne()`](/attendance/attendances-query-builder/ne),[`in()`](/attendance/attendances-query-builder/in),[`ascending()`](/attendance/attendances-query-builder/ascending)|
|`numberOfAttendees`|[`eq()`](/attendance/attendances-query-builder/eq),[`ne()`](/attendance/attendances-query-builder/ne),[`in()`](/attendance/attendances-query-builder/in),[`lt()`](/attendance/attendances-query-builder/lt),[`le()`](/attendance/attendances-query-builder/le),[`gt()`](/attendance/attendances-query-builder/gt),[`ge()`](/attendance/attendances-query-builder/ge),[`ascending()`](/attendance/attendances-query-builder/ascending),[`descending()`](/attendance/attendances-query-builder/descending)|

import { createClient, OAuthStrategy } from '@wix/sdk';
import { attendance } from '@wix/bookings';

const wixClient = createClient({
  modules: { attendance } ,
  auth: OAuthStrategy({ clientId: 'MY-CLIENT-ID' })
});

async function queryAttendance() {
  const { items } = await wixClient.attendance.queryAttendance().find();
}

queryAttendance() with visitor/member access

import { createClient, ApiKeyStrategy } from '@wix/sdk';
import { attendance } from '@wix/bookings';

const wixClient = createClient({
  modules: { attendance },
  auth: ApiKeyStrategy({
    siteId: 'MY-SITE-ID',
    apiKey: 'MY-API-KEY'
  })
});

async function queryAttendance() {
  const { items } = await wixClient.attendance.queryAttendance().find();
}

queryAttendance() with API Key access

import { createClient } from '@wix/sdk';
import { dashboard } from '@wix/dashboard';
import { attendance } from '@wix/bookings';

const wixClient = createClient({
  modules: { attendance },
  auth: dashboard.auth(),
  host: dashboard.host()
});

async function queryAttendance() {
  const { items } = await wixClient.attendance.queryAttendance().find();
}

queryAttendance() with Dashboard app access

queryAttendance

AttendancesQueryBuilder

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

attendance

options

SetAttendanceOptions

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).

import { createClient, ApiKeyStrategy } from '@wix/sdk';
import { attendance } from '@wix/bookings';

const wixClient = createClient({
  modules: { attendance },
  auth: ApiKeyStrategy({
    siteId: 'MY-SITE-ID',
    apiKey: 'MY-API-KEY'
  })
});

async function setAttendance(attendance, options) {
  const response = await wixClient.attendance.setAttendance(attendance, options);
}

setAttendance() with API Key access

import { createClient } from '@wix/sdk';
import { dashboard } from '@wix/dashboard';
import { attendance } from '@wix/bookings';

const wixClient = createClient({
  modules: { attendance },
  auth: dashboard.auth(),
  host: dashboard.host()
});

async function setAttendance(attendance, options) {
  const response = await wixClient.attendance.setAttendance(attendance, options);
}

setAttendance() with Dashboard app access

setAttendance

SetAttendanceResponse

To use the Attendance API, install the `@wix/bookings` package using npm or Yarn:
  ```console
npm install @wix/bookings
```

or

```console
yarn add @wix/bookings
```

Then import `{ attendance }` from `@wix/bookings`:

```js
import { attendance } from '@wix/bookings'
```
  

AttendancesQueryResult

bookings_attendance

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

number

sessionId

Status indicating if any participants 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

AttendanceStatus

Adds a sort to a query, sorting by the specified properties in ascending order.

The `ascending()` function refines a `AttendancesQueryBuilder` to sort by the value of `propertyName` in ascending order.
You can specify multiple properties for sorting in ascending order by passing each property name as an additional argument. `ascending()` sorts the results in the order the properties are passed.
You can sort the following types:
- Number: Sorts numerically.
- Date: Sorts by date and time.
- String: Sorts lexicographically, so `'abc'` comes after `'XYZ'`.
If a property contains a number stored as a string (for example, `'0'`), that value is sorted alphabetically and not numerically. If a property doesn't have a value, that value is ranked lowest.

ascending

Adds a sort to a query, sorting by the specified properties in descending order.

The `descending()` function refines a `AttendancesQueryBuilder` to sort by the value of `propertyName` in descending order.
You can specify multiple properties for sorting in descending order by passing each property name as an additional argument. `descending()` sorts the results in the order the properties are passed.
You can sort the following types:
- Number: Sorts numerically.
- Date: Sorts by date and time.
- String: Sorts lexicographically, so `'abc'` comes after `'XYZ'`.
If a property contains a number stored as a string (for example, `'0'`), that value is sorted alphabetically and not numerically. If a property doesn't have a value, that value is ranked lowest.

descending

Refines a query to match items where the specified property equals the specified value.

The `eq()` function refines a `AttendancesQueryBuilder` to match only items where the value of the specified `propertyName` equals the specified `value`.
`eq()` matches only values of the same type. For example, `0` stored as a number doesn't match `'0'` stored as a string.
Matching strings with `eq()` is case-sensitive, so `'text'` isn't equal to `'Text'`.

Returns the query results.

The `find()` function returns a Promise that resolves to the query results and metadata.
The Promise is rejected if `find()` is called with insufficient permissions or if any of the previous functions used to refine the query are invalid.

find

Refines a query to match items where the specified property is greater than or equal to the specified value.

The `ge()` function refines a `AttendancesQueryBuilder` to match only items where the value of the specified `propertyName` is greater than or equal to the specified `value`.
`ge()` matches only values of the same type. For example, `0` stored as a number doesn't match `'0'` stored as a string.
If a property contains a number stored as a string (for example, `'0'`), that value is compared alphabetically and not numerically. If a property doesn't have a value, that value is ranked lowest.
The following types of properties can be compared:
- Number: Compares numerically.
- Date: Compares JavaScript Date objects. 
- String: Compares lexicographically, so `'abc'` is greater than `'ABC'`.

Refines a query to match items where the specified property is greater than the specified value.

The `gt()` function refines a `AttendancesQueryBuilder` to match only items where the value of the specified `propertyName` is greater than the specified `value`.
`gt()` matches only values of the same type. For example, `0` stored as a number doesn't match `'0'` stored as a string.
If a property contains a number stored as a string (for example, `'0'`), that value is compared alphabetically and not numerically. If a property doesn't have a value, that value is ranked lowest.
The following types of properties can be compared:
- Number: Compares numerically.
- Date: Compares JavaScript Date objects. 
- String: Compares lexicographically, so `'abc'` is greater than `'ABC'`.

Refines a query to only match items where the specified property conatins any of the values in the provided array of values.

The `in()` function refines a `AttendancesQueryBuilder` to match only items where the specified `propertyName` is equal to any of the values in the provided array.
Matching strings with `in()` is case-sensitive, so `'text'` isn't equal to `'Text'`.

Refines a query to match items where the specified property is less than or equal to the specified value.

The `le()` function refines a `AttendancesQueryBuilder` to match only items where the value of the specified `propertyName` is less than or equal to the specified `value`.
`le()` matches only values of the same type. For example, `0` stored as a number doesn't match `'0'` stored as a string.
If a property contains a number stored as a string (for example, `'0'`), that value is compared alphabetically and not numerically. If a property doesn't have a value, that value is ranked lowest.
The following types of properties can be compared:
- Number: Compares numerically.
- Date: Compares JavaScript Date objects. 
- String: Compares lexicographically, so `'ABC'` is less than `'abc'`.

Limits the number of items the query returns.

The `limit()` function defines the number of results a query returns in each page. Only one page of results is retrieved at a time.
You can use the `next()` and `prev()` functions to navigate the pages of a query result.

limit

Refines a query to match items where the specified property is less than the specified value.

The `le()` function refines a `AttendancesQueryBuilder` to match only items where the value of the specified `propertyName` is less than the specified `value`.
`le()` matches only values of the same type. For example, `0` stored as a number doesn't match `'0'` stored as a string.
If a property contains a number stored as a string (for example, `'0'`), that value is compared alphabetically and not numerically. If a property doesn't have a value, that value is ranked lowest.
The following types of properties can be compared:
- Number: Compares numerically.
- Date: Compares JavaScript Date objects. 
- String: Compares lexicographically, so `'ABC'` is less than `'abc'`.

Refines a query to match items where the specified property doesn't equal the specified value.

The `ne()` function refines a `AttendancesQueryBuilder` to match only items where the value of the specified `propertyName` doesn't equal the specified `value`.
`ne()` matches only values of the same type. For example, `0` stored as a number doesn't match `'0'` stored as a string.
Matching strings with `ne()` is case-sensitive, so `'text'` isn't equal to `'Text'`.

Refines a query that skips to a specific record.

The `skipTo()` function refines a `AttendancesQueryBuilder` to return items that appear before or after the item pointed to by the provided cursor. Get the relevant cursor for a specific item from the `cursors` object in previous call's response. Then you can skip to `cursors.prev` to return items before the cursor, or `cursors.next` to return items after the cursor.
 
When using `skipTo()`, the filters and the sorting order of the original query can't be changed. Only the `limit()` property of the query can be changed.

hasNext

boolean

Indicates whether the query has previous results.

You can use the [`next()`](#next) and [`prev()`](#prev) functions returned by `attendance` to navigate the pages of a query result.

hasPrev

Retrieves the next page of query results.

The `next()` function retrieves the next page of query results.
The page size is defined by the [`limit()`](bookings.Attendances.AttendancesQueryBuilder#limit) function and can be retrieved using the [`pageSize`](#pagesize) property. You can use the [`next()`](#next) and [`prev()`](#prev) functions returned by `attendance` to navigate the pages of a query result.
If items are added or removed between calls to `next()`, the values returned by `AttendancesQueryBuilder` may change.

Retrieves the previous page of query results.

The `prev()` function retrieves the previous page of query results.
The page size is defined by the [`limit()`](bookings.Attendances.AttendancesQueryBuilder#limit) function and can be retrieved using the [`pageSize`](#pagesize) property. You can use the [`next()`](#next) and [`prev()`](#prev) functions returned by `attendance` to navigate the pages of a query result.
If items are added or removed between calls to `prev()`, the values returned may change.

cursors

Cursors

Returns an array of `attendance` items that match the query.

`items` contains the current page of results retrieved by the query.
If no results match the query, `items` is an empty array.
The page size is defined by the [`limit()`](bookings.Attendances.AttendancesQueryBuilder#limit) function and can be retrieved using the [`pageSize`](#pagesize) property. You can use the [`next()`](#next) and [`prev()`](#prev) functions returned by `attendance` to navigate the pages of a query result.

items

Returns the number of items in the current page of results.

`length` returns just the number of items in the current page, not the total number of items that match the query. For the total number of items that match the query, see [`totalCount`](#totalcount).
The page size is defined by the [`limit()`](bookings.Attendances.AttendancesQueryBuilder#limit) function and can be retrieved using the [`pageSize`](#pagesize) property. You can use the [`next()`](#next) and [`prev()`](#prev) functions returned by `attendance` to navigate the pages of a query result.

length

Returns the requested page size.

`pageSize` returns the page size set in [`limit()`](bookings.Attendances.AttendancesQueryBuilder#limit) in `AttendancesQueryBuilder`.

pageSize

Returns the `AttendancesQueryBuilder` object used to get the current results.

Use `query` to create and run a new query by chaining additional `AttendancesQueryBuilder` functions to it. You can filter only on properties that haven't already been used in the previous `AttendancesQueryBuilder`.

query

Cursor pointing to next page in the list of results.

Cursor pointing to previous page in the list of results.

ParticipantNotification

Optional custom message to send to the participants about the changes to the booking.

message

Whether to send the message about the changes to the customer.
Default is false.

notifyParticipants

Information about whether to send a message to a customer after their attendance was set.

participantNotification

The created or updated attendance information for the booked session.

Setup