Skip to main content
GET
/
calendar
/
v2
/
rs
/
events
Retrieves a list of events
curl --request GET \
  --url https://z52mnqg347.execute-api.eu-west-3.amazonaws.com/main/calendar/v2/rs/events \
  --header 'Authorization: Bearer <token>' \
  --header 'content-type: <content-type>' \
  --header 'x-session-token: <x-session-token>'
{
  "data": [
    {
      "id": 1,
      "status": 2,
      "type": 1,
      "description": "Description of the intervention",
      "imgSignature": "Signature image",
      "codePin": 123456,
      "autoCreated": true,
      "creationStatus": 1,
      "scheduledStart": "2024-12-01T12:34:56.000Z",
      "scheduledEnd": "2024-12-05T14:56:23.000Z",
      "actualStart": "2024-12-01T12:34:56.000Z",
      "actualEnd": "2024-12-01T12:34:56.000Z",
      "providerName": "Provider name",
      "providerEmail": "example@mail.fr",
      "providerActionComment": "Action comment from the provider",
      "providerGeneralComment": "General comment from the provider",
      "assignedCompanyContactId": 1,
      "assignedUserId": 1,
      "verifiedByUserId": 1,
      "verifiedAt": "2024-12-09T14:23:00.000Z",
      "decisionComment": "Provider refused the intervention due to scheduling conflicts.",
      "attendeeCount": 25,
      "routineId": 1,
      "organizationId": 1,
      "createdByUserId": 1,
      "archivedAt": "2024-12-09T14:23:00.000Z",
      "updatedAt": "2024-12-09T14:23:00.000Z",
      "createdAt": "2024-01-15T08:45:00.000Z",
      "eventType": 123
    }
  ],
  "totalCount": 100,
  "pagination": {
    "page": 1,
    "pageSize": 50
  }
}

Authorizations

​
Authorization
string
header
required

Bearer authentication header of the form Bearer <token>, where <token> is your auth token.

Headers

​
x-session-token
string
required

Session token used for authenticating the request.

Example:

"eyJhbGciOiJIUzI1NiIsInR5cCI6IkpXVCJ9.eyJ1c2VySWQiOiIxMjM0NTY3ODkwIiwic2Vzc2lvbklkIjoiYWJjZGVmMTIzNDU2IiwiaWF0IjoxNjA1MDk3ODk5LCJleHAiOjE2MDUxODQyOTl9.4XRQ1iXDyvEj5LgPZHbmTmzOZs98M3YPOzgf3MhxjaI"

​
content-type
string
required

Content type, must be "application/json".

Allowed value: "application/json"

Query Parameters

​
includeCount
boolean
default:false

Include total count in response.

Example:

true

​
page
integer
default:1

Page number.

Required range: -9007199254740991 <= x <= 9007199254740991
Example:

1

​
pageSize
integer
default:50

Page size.

Required range: -9007199254740991 <= x <= 9007199254740991
Example:

50

​
findId
integer

Get the page where the item with this id is located.

Required range: -9007199254740991 <= x <= 9007199254740991
Example:

1

​
subPageSize
integer
default:10

Sub page size for grouping items.

Required range: -9007199254740991 <= x <= 9007199254740991
Example:

10

​
scheduledEnd
string<date-time>
required
Pattern: ^(?:(?:\d\d[2468][048]|\d\d[13579][26]|\d\d0[48]|[02468][048]00|[13579][26]00)-02-29|\d{4}-(?:(?:0[13578]|1[02])-(?:0[1-9]|[12]\d|3[01])|(?:0[469]|11)-(?:0[1-9]|[12]\d|30)|(?:02)-(?:0[1-9]|1\d|2[0-8])))T(?:(?:[01]\d|2[0-3]):[0-5]\d(?::[0-5]\d(?:\.\d+)?)?(?:Z))$
​
scheduledStart
string<date-time>
required
Pattern: ^(?:(?:\d\d[2468][048]|\d\d[13579][26]|\d\d0[48]|[02468][048]00|[13579][26]00)-02-29|\d{4}-(?:(?:0[13578]|1[02])-(?:0[1-9]|[12]\d|3[01])|(?:0[469]|11)-(?:0[1-9]|[12]\d|30)|(?:02)-(?:0[1-9]|1\d|2[0-8])))T(?:(?:[01]\d|2[0-3]):[0-5]\d(?::[0-5]\d(?:\.\d+)?)?(?:Z))$
​
includeSites
boolean
required

Response

200 - application/json

List of events

​
data
object[]
required
​
totalCount
integer

Total count of items.

Required range: -9007199254740991 <= x <= 9007199254740991
Example:

100

​
pagination
object

Pagination information.