KAkaleyra
User

Get users

Get a list of users.

get/v2/users

Request

  • Base URL
    https://api.sandbox.eu.bandyer.com
  • URL
    https://api.sandbox.eu.bandyer.com/v2/users
  • Auth
    API key in header apikey

Query parameters

offsetinteger

The number of items to skip before starting to collect the result set

limitinteger

The numbers of items to return

role'basic' | 'plus'

User role.

allow_cameraboolean

Indicates if users allowed to do video call or not.

activeboolean

Indicates if user is active or not.

searchstring

To search users that starting with X. To search minimum required are 2 characters

Response

offsetinteger

The number of items to skiped before starting to collect the result set.

limitinteger

The numbers of items to returned.

has_moreboolean

Indicates is there more values.

countinteger

Total number of values returned.

Example response

{
  "users": [
    {
      "creation_date": "2023-01-01T00:00:00Z"
    }
  ]
}

Changes

No recorded changes to this operation across all 1 revision of this API.