Skip to main content
GET
/
users
/
v1
/
rs
/
{userId}
Get user
curl --request GET \
  --url https://z52mnqg347.execute-api.eu-west-3.amazonaws.com/main/users/v1/rs/{userId} \
  --header 'Authorization: Bearer <token>' \
  --header 'x-session-token: <x-session-token>'
{
  "data": {
    "id": 1,
    "key": "a13f2277-4009-458b-93c6-bc77f447281b",
    "firstName": "John",
    "lastName": "Doe",
    "email": "test@mail.com",
    "phone": "0123456789",
    "type": 1,
    "lang": "fr",
    "activatedAt": "2024-12-09T14:23:00.000Z",
    "updatedAt": "2024-12-09T14:23:00.000Z",
    "createdAt": "2024-01-15T08:45:00.000Z",
    "presignedUrl": "https://example.com/presigned-url",
    "permissions": {
      "group": 1,
      "read": [
        1,
        2
      ],
      "manage": [
        1,
        2
      ]
    },
    "scope": 1,
    "profession": {
      "id": 1,
      "name": "Urgent"
    },
    "updatableFields": {
      "firstName": true,
      "lastName": true,
      "email": true,
      "phone": true,
      "lang": true
    },
    "actions": {
      "canBeUpdated": true,
      "canBeDeleted": true
    },
    "userOrganizationActions": {
      "canBeUpdated": true,
      "canBeDeleted": true,
      "isMe": true
    },
    "userOrganizationUpdatableFields": {
      "firstName": true,
      "lastName": true,
      "professionId": true,
      "scope": true,
      "permissions": true
    }
  }
}

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"

Path Parameters

​
userId
integer
required

Unique identifier of the site.

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

1

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

  • "updatable-fields": Get information about the field that can be updated

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

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

  • "user-organization-updatable-fields": Get the user organization updatable fields of the user for the target organization

Available options:
image,
organization,
updatable-fields,
actions-info,
user-organization-actions-info,
user-organization-updatable-fields

Response

200 - application/json

Get of user

​
data
object
required