Skip to main content
GET
/
users
/
v1
/
bo
List bo users
curl --request GET \
  --url https://z52mnqg347.execute-api.eu-west-3.amazonaws.com/main/users/v1/bo \
  --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",
      "deletedAt": "2024-12-15T10:00:00.000Z",
      "presignedUrl": "https://example.com/presigned-url",
      "permissions": {
        "group": 1,
        "read": [
          1,
          2
        ],
        "manage": [
          1,
          2
        ]
      },
      "updatableFields": {
        "firstName": true,
        "lastName": true,
        "email": true,
        "phone": true,
        "lang": true
      },
      "actions": {
        "canBeUpdated": true,
        "canBeDeleted": 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"

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

Available options:
image,
organization,
updatable-fields,
actions-info
​
whereType
integer

Filter by type

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

1

​
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

​
whereOrganizationId
integer

Filter by organization id

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

1

​
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"

​
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 of bo users

​
data
object[]
required
​
totalCount
integer

Total count of items.

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

100

​
pagination
object

Pagination information.