BObookingexperts
Users

GET users

Returns users that are part of the current organization

get/v3/users

Request

Query parameters

page[number]integer

Page number

page[size]integer

Page size

sortstring

Sort. Specify a comma separated list of attributes to sort on. Prefix attribute with a - to sort in descending order. Allowed attributes: id, created_at, updated_at

fields[user]string

Fieldset. Specify a comma separated list of attributes to return

filter[id]string

Filter on ID

filter[email]string

Filter on email

filter[mobile_phone]string

Filter on mobile_phone

filter[locale]string

Filter on locale

filter[timezone]string

Filter on timezone

filter[created_at]string

Filter on created_at

filter[updated_at]string

Filter on updated_at

Headers

Accept-Languagestring

Supported languages. A comma separated list with one or more of the following locales: cs, da-DK, de, de-AT, de-CH, en-US, en-GB, es, fr, fr-BE, fr-LU, it, nb, nl, nl-BE, pl, pt, tr, en, da. Default: 'en'.

Response

UserCollectionResponse

Example response

{
  "data": [
    {
      "id": "1",
      "type": "user",
      "attributes": {
        "locale": "nl"
      }
    }
  ]
}

Changes

No recorded changes to this operation across all 2 revisions of this API.