# List Completed Study Sessions

**GET /sessions/completed**

Provides a general purpose endpoint to search Completed Study Sessions.

The date range is limited to a maximum of 12 months, if no filters are provided it defaults to the last 12 months.

**Date Range Behavior**:
- If no date filters are provided, it defaults to the last 12 months.
- If only `endDate[lte]` is provided, `endDate[gte]` will default to 12 months prior to `endDate[lte]`.
- If only `endDate[gte]` is provided, `endDate[lte]` will default to 12 months after `endDate[gte]`.

**Nugget Filters**:

Nugget filters are combined when used together. For example, specifying both `nuggetId` and a `courseId` will include nuggets from both the specified IDs and the course.

**User Filters**:

User filters are combined when used together and allow you to specify users by `userId`, `externalId`, or `classId`. When using `classId`, the results will include study sessions for all users within the specified class.


## Servers
- Production: https://connect.century.tech/api/v1 (Production)


## Authentication methods
- Api key


## Parameters


### Query parameters
- **endDate** (object)
  Filter the results by session end date

  Supports either a ISO 8601 formatted date or a Unix timestamp. 
  For example `endDate[gte]=1688200245` or `endDate[lte]=2023-07-15T12:00:00.000Z`
- **userId** (array[string(uuid)])
  Filter the results by user ID.

  Multiple identifiers can be specified by repeating the query parameter. e.g. `userId=value1&userId=value2`

  This parameter supports a maximum of 30 identifiers.
- **externalId** (array[string])
  Filter the results by external ID.

  Multiple identifiers can be specified by repeating the query parameter. e.g. `externalId=value1&externalId=value2`

  This parameter supports a maximum of 30 identifiers.
- **nuggetId** (array[string(uuid)])
  Filter the results by nugget ID.

  Multiple identifiers can be specified by repeating the query parameter. e.g. `nuggetId=value1&nuggetId=value2`

  This parameter supports a maximum of 30 identifiers.
- **classId** (string(uuid))
  Filter the results by class ID.
- **courseId** (string(uuid))
  Filter the results by course ID.
- **sort** (object)
  Specify the sort order of the results.

  The default sort order is `sort[field]=endDate&sort[direction]=asc`
- **limit** (integer(int32))
  The maximum number of sessions to return per page.
- **offset** (integer(int32))
  Indicates the starting position or index (offset)
- **cursor** (string(byte) | null)
  The cursor for pagination. Encoded byte string used to navigate between pages.


## Responses
### 200
List of Study Sessions

#### Body: application/json (object)
- **data** (array[object])

- **pagination** (object)
  Metadata for the current pagination position

### 400
Invalid request.

### 401
Invalid authentication credentials

### 403
Not authorised to access this resource


[Powered by Bump.sh](https://bump.sh)