# List Users

Get a list of users in the organization.

Endpoint: GET /api/v1/users
Version: 0.2.0
Security: bearerAuth

## Query parameters:

  - `sort_by` (array)
    Enum: "role_asc", "role_desc", "email_asc", "email_desc", "created_asc", "created_desc", "name_asc", "name_desc", "last_keep_alive_asc", "last_keep_alive_desc", "state_asc", "state_desc", "type_asc", "type_desc"

  - `page` (integer)

  - `size` (integer)
    The number of items per page.

  - `types` (array)
    The types of the users to filter on.
    Enum: "person", "api_signer", "api_user", "system"

  - `roles` (array)
    The roles of the users to filter on.
    Enum: "admin", "trader", "viewer"

  - `states` (array)
    The states of the users to filter on.  Is one of: : The user can perform all actions in the Fordefi platform.: The user has been approved but still needs to generate a code for the user.: The user has been generated a code but still needs to activate the account with it.: The user has been deleted.
    Enum: "active", "onboarding_pending_code_generation", "onboarding_pending_activation", "reset_device_pending_code_generation", "reset_device_pending_activation", "pending_approval", "deleted"

  - `include_deleted` (boolean)
    to include deleted users in the response,  otherwise.

  - `names` (array)
    The names of the users.

  - `emails` (array)
    The emails of the users.

  - `user_ids` (array)
    The unique identifiers of the users.

  - `external_ids` (array)
    The IDs that you assign to the end user.

  - `group_ids` (array)
    The unique identifiers of the user groups.

  - `group_ids__not` (array)
    The unique identifiers of the user groups to exclude.

  - `states_on_groups` (array)
    The states of the user groups to filter group_ids on. Is one of: : The user group is active.: The user is pending to be added to the group.: The user is pending to be removed from the group.
    Enum: "active", "pending_addition", "pending_removal"

  - `exclude_user_ids` (array)
    The user IDs to exclude.

## Response 200 fields (application/json):

  - `total` (integer, required)

  - `page` (integer, required)

  - `size` (integer, required)

  - `users` (array, required)

## Response 400 fields (application/json):

  - `title` (string, required)
    Human-readable error message.

  - `detail` (string, required)
    Detailed error message.

  - `full_detail` (string)
    Full error message with additional details, if available.

  - `request_id` (string)
    Request ID - for debugging purposes.

  - `system_error_code` (string)
    An additional system error code in Fordefi.

## Response 401 fields (application/json):

  - `title` (string, required)
    Human-readable error message.

  - `detail` (string, required)
    Detailed error message.

  - `full_detail` (string)
    Full error message with additional details, if available.

  - `request_id` (string)
    Request ID - for debugging purposes.

## Response 403 fields (application/json):

  - `title` (string, required)
    Human-readable error message.

  - `detail` (string, required)
    Detailed error message.

  - `full_detail` (string)
    Full error message with additional details, if available.

  - `request_id` (string)
    Request ID - for debugging purposes.

## Response 408 fields (application/json):

  - `title` (string, required)
    Human-readable error message.

  - `detail` (string, required)
    Detailed error message.

  - `full_detail` (string)
    Full error message with additional details, if available.

  - `request_id` (string)
    Request ID - for debugging purposes.

## Response 422 fields (application/json):

  - `title` (string, required)
    Human-readable error message.

  - `detail` (array, required)

  - `detail.loc` (array, required)

  - `detail.msg` (string, required)

  - `detail.type` (string, required)

  - `full_detail` (string)
    Full error message with additional details, if available.

  - `request_id` (string)
    Request ID - for debugging purposes.

## Response 500 fields (application/json):

  - `title` (string, required)
    Human-readable error message.

  - `detail` (string, required)
    Detailed error message.

  - `full_detail` (string)
    Full error message with additional details, if available.

  - `request_id` (string)
    Request ID - for debugging purposes.