# List all Users

Retrieve a list of all .

For details on how to query endpoints using the available parameters, see Query Parameters.

Endpoint: GET /users
Security: BasicAuth

## Response 200 fields (application/json):

  - `page` (object)
    Details the page that's returned.

  - `page.count` (integer)
    The number of entries returned.

  - `page.limit` (integer)
    The number of entries to return.

  - `page.offset` (integer)
    The number of items to skip before starting to collect the result set.

  - `_embedded` (object)
    List of  objects.

  - `_embedded.users` (array)
    objects.

  - `_embedded.users.id` (string)
    The ID of the  object.

  - `_embedded.users.created_at` (string)
    Timestamp of when the object was created.

  - `_embedded.users.updated_at` (string)
    Timestamp of when the object was last updated.

  - `_embedded.users.created_by` (string)
    The ID of the application user that created _this_ user.

  - `_embedded.users.email` (string)
    The email address of the application user (max 100 characters).

  - `_embedded.users.enabled` (boolean)
    Whether the  is enabled and active. Set to  to disable the .

  - `_embedded.users.identity` (string,null)
    ID of the  that the  object was created under.
    Example: "IDxxxxxxxxxxxxxxxxxx"

  - `_embedded.users.last_used_date` (string)
    Timestamp of when the user credentials were last used to make an API call.

  - `_embedded.users.password` (string,null)
    The  you'll use to authetnicate requests.

  - `_embedded.users.role` (string)
    Details the level of access the [](#Users) has available.
    Enum: "ROLE_ADMIN", "ROLE_PLATFORM", "ROLE_PARTNER", "ROLE_MERCHANT"

  - `_embedded.users.tags` (object,null)
    Include up to 50  pairs to annotate requests with custom metadata.
- Maximum character length for individual  is 40.
- Maximum character length for individual  is 500.
(For example, , , )

  - `_embedded.users._links` (object)
    For your convenience, every response includes several URLs which link to resources relevant to the request. You can use these  to make your follow-up requests and quickly access relevant IDs.

  - `_embedded.users._links.application` (object)
    Link to the  the resource was created under.

  - `_embedded.users._links.application.href` (string)

  - `_embedded.users._links.applications` (object)

  - `_embedded.users._links.self` (object)
    Link to the resource that was used in the request.

## Response 401 fields (application/json):

  - `total` (integer)

  - `_embedded` (object)

  - `_embedded.errors` (array)

  - `_embedded.errors.code` (string)
    Enum: "UNKNOWN"

  - `_embedded.errors.logref` (object)

  - `_embedded.errors.message` (string)

  - `_embedded.errors._links` (object)

  - `_embedded.errors._links.self` (object)

  - `_embedded.errors._links.self.href` (string)

  - `_embedded.errors._links.source` (object)

## Response 403 fields (application/json):

  - `total` (integer)

  - `_embedded` (object)

  - `_embedded.errors` (array)

  - `_embedded.errors.code` (string)
    Enum: "FORBIDDEN"

  - `_embedded.errors.logref` (object)

  - `_embedded.errors.message` (string)

  - `_embedded.errors._links` (object)

  - `_embedded.errors._links.source` (object)

  - `_embedded.errors._links.source.href` (string)

## Response 406 fields (application/json):

  - `total` (integer)

  - `_embedded` (object)

  - `_embedded.errors` (array)

  - `_embedded.errors.code` (string)
    Enum: "NOT_FOUND"

  - `_embedded.errors.logref` (object)

  - `_embedded.errors.message` (string)

  - `_embedded.errors._links` (object)

  - `_embedded.errors._links.source` (object)

  - `_embedded.errors._links.source.href` (string)