Skip to main content
GET
/
interventions-users
/
v1
/
rs
List intervention users
curl --request GET \
  --url https://z52mnqg347.execute-api.eu-west-3.amazonaws.com/main/interventions-users/v1/rs \
  --header 'Authorization: Bearer <token>' \
  --header 'x-session-token: <x-session-token>'
{
  "data": [
    {
      "id": 1,
      "userId": 1,
      "interventionId": 1,
      "attendanceStatus": "present",
      "attendanceProof": {
        "id": 1,
        "name": "document.pdf",
        "presignedUrl": "https://example.com/presigned-url"
      },
      "updatedAt": "2024-01-01T00:00:00.000Z",
      "createdAt": "2024-01-01T00:00:00.000Z",
      "user": {
        "id": 1,
        "key": "a13f2277-4009-458b-93c6-bc77f447281b",
        "type": 1,
        "firstName": "John",
        "lastName": "Doe",
        "email": "test@mail.com",
        "phone": "0123456789",
        "lang": "fr",
        "activatedAt": "2024-12-09T14:23:00.000Z",
        "deletedAt": "2024-12-15T10:00:00.000Z",
        "updatedAt": "2024-12-09T14:23:00.000Z",
        "createdAt": "2024-01-15T08:45:00.000Z",
        "permissions": {
          "group": 1,
          "read": [
            1,
            2
          ],
          "manage": [
            1,
            2
          ]
        },
        "profession": {
          "id": 1,
          "name": "Urgent"
        }
      },
      "intervention": {
        "id": 1,
        "status": 2,
        "type": 1,
        "subType": 1,
        "codePin": 123456,
        "description": "Description of the intervention",
        "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",
        "archivedAt": "2024-12-09T14:23:00.000Z",
        "updatedAt": "2024-12-09T14:23:00.000Z",
        "createdAt": "2024-01-15T08:45:00.000Z",
        "rule": {
          "id": 1,
          "name": "Annual Safety Check",
          "type": 1,
          "sourceType": 1,
          "rrule": "FREQ=YEARLY;BYMONTH=12;BYMONTHDAY=1",
          "workflowType": 1,
          "complianceType": 1,
          "createdAt": "2024-01-15T08:45:00.000Z"
        }
      }
    }
  ],
  "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"

Query Parameters

​
extend
enum<string>[]

Extend options:

  • "user": Get the users with specific fields

  • "user-organization": Obtain the organization in which the profile is involved

  • "intervention": Get the interventions with specific fields

  • "intervention-rule": Get the interventions with specific fields

Available options:
user,
user-organization,
intervention,
intervention-rule
​
whereUserId
integer

Filter by User ID

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

1

​
whereUserIds
integer[]

Filter by multiple User IDs

Required range: -9007199254740991 <= x <= 9007199254740991
Example:
[1, 2, 3]
​
whereInterventionId
integer

Filter by Intervention ID

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

1

​
whereInterventionIds
integer[]

Filter by multiple Intervention IDs

Required range: -9007199254740991 <= x <= 9007199254740991
Example:
[1, 2, 3]
​
whereAttendanceStatus
string[]

Filter by attendance status

Example:
["A", "B", "C"]
​
whereAttendanceProofName
string

Filter by attendance proof name

Example:

"string"

​
orderBy
object[]
​
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

Response

200 - application/json

List intervention users

​
data
object[]
required
​
totalCount
integer

Total count of items.

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

100

​
pagination
object

Pagination information.