# Returns a list of Events (V1) based on filter criteria

Retrieves events based on filter criteria. Supports pagination and various filtering options.

Endpoint: GET /v1/events
Version: 191.0.3
Security: bearerAuth, oAuthSandbox

## Security:

  - `bearerAuth` (unknown)
    http bearer JWT

  - `oAuthSandbox` (unknown)
    oauth2

## Query parameters:

  - `responseFields` (string)
    A URL-encoded, comma-delimited list of field names to include in the response data. Additionally, the following values are also supported:

ALL - Returns all field names.

  - `filter` (string)
    Filter clauses for events. General grammar and operators: the Public API filter documentation.
**Auto filter:** If you omit a date-limiting filter (such as `lastModified`), the server may apply one automatically; behavior can vary by deployment.
**Keys and operators (this endpoint)**
- `id` (`->`)
- `title` (`==`, `!=`, `~=`, `<>=`)
- `start` (`>`, `<`, `>=`, `<=`)
- `operatory.id` (`==`, `!=`, `->`)
- `location.id` (`==`, `!=`, `->`)
- `lastModified` (`>=`, `>`, `<=`, `<`)
- `groupId` (`==`)
**Ordering:** When filtering by `start`, `lastModified`, results are returned in **descending** order (newest first) where applicable; use `lastId` with date filters for stable pagination.

Examples: `location.id==12`, `start>=2022-01-01`, `operatory.id==12`, `groupId==value`, `title~=Smith`.

  - `page` (string)
    Page number for pagination control

  - `pageSize` (string)
    Page size for pagination control

  - `lastId` (string)
    the biggest eventId from previous page

## Header parameters:

  - `Organization-ID` (string, required)
    Organization context for the request. Must match the organization authorized by the access token.

## Response 200:

  - `200` (unknown)
    The request was successful

## Response 200 fields (application/json):

  - `data` (array)

  - `data.title` (string, required)

  - `data.description` (string)
    Example: This is a detailed description of the event.

  - `data.start` (string, required)
    Example: 2018-07-09T19:00:00.000Z

  - `data.end` (string)
    Example: 2018-07-09T20:00:00.000Z

  - `data.allDay` (boolean)
    Example: true

  - `data.recurrenceType` (string)
    Enum: "WEEKLY", "MONTHLY"

  - `data.recurrenceStart` (string)
    Example: 2018-07-09

  - `data.recurrenceEnd` (string)
    Example: 2018-07-09

  - `data.recurrenceFrequency` (integer)
    Example: 1

  - `data.recurrenceDays` (array)
    Example: ["MONDAY","WEDNESDAY","FRIDAY"]

  - `data.recurrenceWeek` (string)
    Enum: "FIRST", "SECOND", "THIRD", "FOURTH", "LAST"

  - `data.recurrenceDay` (string)
    Enum: "SUNDAY", "MONDAY", "TUESDAY", "WEDNESDAY", "THURSDAY", "FRIDAY", "SATURDAY"

  - `data.color` (string)
    Hexadecimal color code (6 characters, without # prefix)
    Example: FF5733

  - `data.id` (integer)
    Example: 32424423

  - `data.duration` (integer)
    This is a field that returns the duration of the appointment in minutes.
    Example: 30

  - `data.lastModified` (string)
    Example: 2018-07-09T19:00:00.000Z

  - `data.groupId` (string)

  - `data.provider` (object)
    A reference to a linked model. Includes the id, the type, and URL at which the model can be accessed.

  - `data.provider.id` (integer, required)
    The unique identifier for the linked model.
    Example: 12345

  - `data.provider.type` (string)
    The type of the linked model. This field is read-only.
    Example: ExampleModelType

  - `data.provider.url` (string, required)
    The URL at which the linked model can be accessed. This field is read-only.
    Example: https://api.example.com/models/12345

  - `data.location` (object, required)
    A reference to a linked model. Includes the id, the type, and URL at which the model can be accessed.

  - `data.location.id` (integer, required)
    The unique identifier for the linked model.
    Example: 12345

  - `data.location.type` (string)
    The type of the linked model. This field is read-only.
    Example: ExampleModelType

  - `data.location.url` (string, required)
    The URL at which the linked model can be accessed. This field is read-only.
    Example: https://api.example.com/models/12345

  - `data.operatory` (object)
    A reference to a linked model. Includes the id, the type, and URL at which the model can be accessed.

  - `data.operatory.id` (integer, required)
    The unique identifier for the linked model.
    Example: 12345

  - `data.operatory.type` (string)
    The type of the linked model. This field is read-only.
    Example: ExampleModelType

  - `data.operatory.url` (string, required)
    The URL at which the linked model can be accessed. This field is read-only.
    Example: https://api.example.com/models/12345

  - `warnings` (array)

  - `warnings.code` (string)

  - `warnings.title` (string)

  - `warnings.description` (string)

  - `warnings.source` (string)

  - `errors` (array)

  - `meta` (object)

  - `meta.pagination` (object)
    Pagination info
    Example: {"limit":10,"offset":0}

  - `meta.pagination.limit` (integer)
    Example: 10

  - `meta.pagination.offset` (integer)
    Example: 0

  - `meta.pagination.total` (integer)
    Example: 100

## Response 400:

  - `400` (unknown)
    The request was invalid or cannot be processed

## Response 401:

  - `401` (unknown)
    Authentication is required and has failed or has not been provided

## Response 403:

  - `403` (unknown)
    The request is understood, but it has been refused or access is not allowed

## Response 404:

  - `404` (unknown)
    The requested resource is either missing or does not exist

## Response 408:

  - `408` (unknown)
    The server timed out while processing the request

## Response 429:

  - `429` (unknown)
    Rate limit exceeded

## Response 500:

  - `500` (unknown)
    An unexpected error occurred

## Response 200 examples:

  - `default` (unknown)