Skip to main content
GET
/
users
/
v1
/
rs
List users
curl --request GET \
  --url https://z52mnqg347.execute-api.eu-west-3.amazonaws.com/main/users/v1/rs \
  --header 'Authorization: Bearer <token>' \
  --header 'x-session-token: <x-session-token>'
{
  "data": [
    {
      "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",
      "updatedAt": "2024-12-09T14:23:00.000Z",
      "createdAt": "2024-01-15T08:45:00.000Z",
      "deletedAt": "2024-12-15T10:00:00.000Z",
      "presignedUrl": "https://example.com/presigned-url",
      "permissions": {
        "group": 1,
        "read": [
          1,
          2
        ],
        "manage": [
          1,
          2
        ]
      },
      "scope": 1,
      "profession": {
        "id": 1,
        "name": "Urgent"
      },
      "diplomas": [
        {
          "id": 1,
          "name": "Urgent"
        }
      ],
      "actions": {
        "canBeUpdated": true,
        "canBeDeleted": true
      },
      "userRuleActions": {
        "canBeDeleted": true
      },
      "userRules": [
        {
          "upcomingInterventionStatus": 1,
          "nextIntervention": {
            "id": 1,
            "status": 2,
            "scheduledStart": "2024-12-01T12:34:56.000Z",
            "scheduledEnd": "2024-12-05T14:56:23.000Z"
          },
          "lastIntervention": {
            "id": 1,
            "status": 2,
            "scheduledStart": "2024-12-01T12:34:56.000Z",
            "scheduledEnd": "2024-12-05T14:56:23.000Z",
            "attendanceStatus": "present",
            "attendanceProof": {
              "id": 1,
              "name": "document.pdf",
              "presignedUrl": "https://example.com/presigned-url"
            }
          },
          "id": 1,
          "dueAt": "2025-03-15T09:00:00.000Z",
          "contractId": 8,
          "routineId": 5,
          "archivedAt": "2024-12-10T10:00:00.000Z",
          "deletedAt": "2024-12-11T15:30:00.000Z",
          "createdAt": "2024-01-15T08:45:00.000Z",
          "rule": {
            "id": 1,
            "name": "Annual Safety Check",
            "sourceType": 1,
            "userScopes": [
              {
                "professionIds": [
                  1,
                  2,
                  3
                ],
                "diplomaIds": [
                  1,
                  2,
                  3
                ]
              }
            ],
            "rrule": "FREQ=YEARLY;BYMONTH=12;BYMONTHDAY=1",
            "createdAt": "2024-01-15T08:45:00.000Z"
          }
        }
      ],
      "stats": {
        "nbPastDue": 5,
        "nbFutureDue": 3
      },
      "userOrganizationActions": {
        "canBeUpdated": true,
        "canBeDeleted": true,
        "isMe": true
      }
    }
  ],
  "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"

​
x-sites
string

List of site IDs.

Example:

"['1', '2']"

Query Parameters

​
extend
enum<string>[]

Extend options:

  • "image": Add the presigned URL for the user image

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

  • "diplomas": Obtain the diplomas associated with the user

  • "actions-info": Give information about actions that can be done on the user

  • "user-rule-actions-info": Get the user rule actions info of the user for the target rule

  • "last-next-intervention": Get the last and next intervention for a rule in a user

  • "stats": Get information about rules statistics

  • "user-rule": Get the rules with specific fields

  • "user-organization-actions-info": Get the user organization actions info of the user for the target organization

Available options:
image,
organization,
diplomas,
actions-info,
user-rule-actions-info,
last-next-intervention,
stats,
user-rule,
user-organization-actions-info
​
whereType
integer[]

Filter by type

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

Filter by first name

Example:

"string"

​
whereLastName
string

Filter by last name

Example:

"string"

​
whereEmail
string

Filter by email

Example:

"string"

​
wherePhone
string

Filter by phone

Example:

"string"

​
whereLang
string

Filter by lang

Example:

"string"

​
whereActivatedAt
object

Filter by activatedAt

Example:
{
  "start": "2021-01-01T00:00:00.000Z",
  "end": "2021-12-31T23:59:59.999Z"
}
​
whereIsDeleted
boolean

Filter by deletion status

Example:

true

​
whereUpdatedAt
object

Filter by updatedAt

Example:
{
  "start": "2021-01-01T00:00:00.000Z",
  "end": "2021-12-31T23:59:59.999Z"
}
​
whereCreatedAt
object

Filter by createdAt

Example:
{
  "start": "2021-01-01T00:00:00.000Z",
  "end": "2021-12-31T23:59:59.999Z"
}
​
whereText
string

Filter by text search in name and description

Example:

"string"

​
whereRuleIds
integer[]

Filter by rule IDs

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

Filter by missing rule ids

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

Filter by rule id that is in the perimeter

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

1

​
whereRuleIdIsNotInPerimeter
integer

Filter by rule id that is not in the perimeter

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

1

​
whereGuest
boolean

Filter by guest

Example:

true

​
whereIsInvited
boolean

Filter by invited users

Example:

true

​
whereFullName
string

Filter by full name

Example:

"string"

​
whereProfessionIds
integer[]

Filter by profession ids

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

Filter by diploma title ids

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

Filter by permissions

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

1

​
orderBy
object[]
​
targetRuleId
integer

Target Rule identifier. Use with extend=target-rule to reveal whether the site is linked to the target rule and whether it can be dissociated.

Required range: -9007199254740991 <= x <= 9007199254740991
​
userRuleOrderBy
object[]
​
whereUserIds
integer[]

Filter by user IDs

Required range: -9007199254740991 <= x <= 9007199254740991
Example:
[1, 2, 3]
​
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 of users

​
data
object[]
required
​
totalCount
integer

Total count of items.

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

100

​
pagination
object

Pagination information.