--- title: "List Users" method: GET path: "/api/v1/users" tags: ["Users"] --- # List Users `GET /api/v1/users` Get a list of users in the organization. ## Query parameters - `sort_by` UserSortableFields[] - `page` integer - `size` integer — The number of items per page. - `skip_count` boolean — Whether to skip counting the total number of items. - `types` UserType[] — The types of the users to filter on. - `roles` UserRole[] — The roles of the users to filter on. - `states` UserState[] — The states of the users to filter on. Is one of: - `include_deleted` boolean — `True` to include deleted users in the response, `False` otherwise. - `names` string[] — The names of the users. - `emails` string[] — The emails of the users. - `user_ids` string[] — The unique identifiers of the users. - `external_ids` string[] — The IDs that you assign to the end user. - `group_ids` string[] — The unique identifiers of the user groups. - `group_ids__not` string[] — The unique identifiers of the user groups to exclude. - `states_on_groups` UserStateOnGroup[] — The states of the user groups to filter group_ids on. Is one of: - `exclude_user_ids` string[] — The user IDs to exclude. ## Response `200` Successful Response - ListUsersResponse - `total` integer, required - `page` integer, required - `size` integer, required - `users` User[], required - union — Represents a user in the Fordefi platform - Person — Represents a human user in the Fordefi platform - `id` string, uuid, required — The unique identifier of the object in the Fordefi platform. - `created_at` string, date-time, required — The date and time when the object was created. - `modified_at` string, date-time, required — The date and time when the object was last modified. Any change to any field of the resource is considered a modification. - `user_type` 'person', required — The type of the user. - `name` string — The name of the user. - `email` string, required — The email of the user. - `state` 'active' | 'onboarding_pending_code_generation' | 'onboarding_pending_activation' | 'reset_device_pending_code_generation' | 'reset_device_pending_activation' | 'pending_approval' | 'deleted', required - `is_new_device_provisioning` boolean — `True` if the user is provisioning a new device, or is onboarding into an organization; `False` otherwise. - `acknowledged_banners` BannerType[], required — The banners that the user has acknowledged. - `role` 'admin' | 'trader' | 'viewer', required - `user_groups` UserGroupRef[] — The groups the user belongs to. - `id` string, uuid, required — The unique identifier of user group in the Fordefi platform. - `name` string, required — The name of the user group. - `users_count` integer, required — The number of users in the group. - `admins_count` integer, required — The number of admins in the group. - `state` 'active' | 'deleted', required — Represents a user group state in the Fordefi platform - `pending_addition_to_user_groups` UserGroupRef[] — The groups the user is pending to be added to. - `id` string, uuid, required — The unique identifier of user group in the Fordefi platform. - `name` string, required — The name of the user group. - `users_count` integer, required — The number of users in the group. - `admins_count` integer, required — The number of admins in the group. - `state` 'active' | 'deleted', required — Represents a user group state in the Fordefi platform - `pending_removal_from_user_groups` UserGroupRef[] — The groups the user is pending to be removed from. - `id` string, uuid, required — The unique identifier of user group in the Fordefi platform. - `name` string, required — The name of the user group. - `users_count` integer, required — The number of users in the group. - `admins_count` integer, required — The number of admins in the group. - `state` 'active' | 'deleted', required — Represents a user group state in the Fordefi platform - `pending_change` PendingUserChangeRef - `new_role` 'admin' | 'trader', required — The new role of the user. - `change_request_id` string, uuid, required — The unique identifier of the change request. - `device_backup_info` DeviceBackupInfoExt - `device_backup_info` union, required — The type of the backup. - Cloud - … - Mnemonic - … - `backup_created_at` string, date-time, required — The time when the backup was created. - `backup_last_verified_at` string, date-time, required — The time when the backup was last verified. - `invited_by` union — Represents a reference to a user in the Fordefi platform - PersonRef - `id` string, uuid, required — The unique identifier of the user in the Fordefi platform. - `user_type` 'person', required — The type of user. Can be a person, or (in programmatic scenarios) an API user or API Signer. - `name` string — The name of the user. - `email` string, required — The email of the user. - `state` 'active' | 'onboarding_pending_code_generation' | 'onboarding_pending_activation' | 'reset_device_pending_code_generation' | 'reset_device_pending_activation' | 'pending_approval' | 'deleted', required - `role` 'admin' | 'trader' | 'viewer', required - ApiUserRef - `id` string, uuid, required — The unique identifier of the user in the Fordefi platform. - `user_type` 'api_user', required — The type of the user. - `name` string, required — The name of the user. - `state` 'active' | 'deleted', required — The state of the user. - `role` 'admin' | 'trader' | 'viewer', required - ApiSignerRef - `id` string, uuid, required — The unique identifier of the user in the Fordefi platform. - `user_type` 'api_signer', required — The type of the user. - `name` string, required — The name of the user. - `state` 'active' | 'onboarding_pending_code_generation' | 'onboarding_pending_activation' | 'deleted', required — The state of the user. - EndUserRef - `id` string, uuid, required — The unique identifier of the user in the Fordefi platform. - `user_type` 'end_user', required — The type of the user. - `external_id` string, required — External id of the user. - `state` 'active' | 'deleted', required — The state of the user. - SystemUserRef - `id` string, uuid, required — The unique identifier of the user in the Fordefi platform. - `user_type` 'system', required — The type of the user. - `name` string, required — The name is Fordefi CARE - `device_reset_by` union — Represents a reference to a user in the Fordefi platform - PersonRef - `id` string, uuid, required — The unique identifier of the user in the Fordefi platform. - `user_type` 'person', required — The type of user. Can be a person, or (in programmatic scenarios) an API user or API Signer. - `name` string — The name of the user. - `email` string, required — The email of the user. - `state` 'active' | 'onboarding_pending_code_generation' | 'onboarding_pending_activation' | 'reset_device_pending_code_generation' | 'reset_device_pending_activation' | 'pending_approval' | 'deleted', required - `role` 'admin' | 'trader' | 'viewer', required - ApiUserRef - `id` string, uuid, required — The unique identifier of the user in the Fordefi platform. - `user_type` 'api_user', required — The type of the user. - `name` string, required — The name of the user. - `state` 'active' | 'deleted', required — The state of the user. - `role` 'admin' | 'trader' | 'viewer', required - ApiSignerRef - `id` string, uuid, required — The unique identifier of the user in the Fordefi platform. - `user_type` 'api_signer', required — The type of the user. - `name` string, required — The name of the user. - `state` 'active' | 'onboarding_pending_code_generation' | 'onboarding_pending_activation' | 'deleted', required — The state of the user. - EndUserRef - `id` string, uuid, required — The unique identifier of the user in the Fordefi platform. - `user_type` 'end_user', required — The type of the user. - `external_id` string, required — External id of the user. - `state` 'active' | 'deleted', required — The state of the user. - SystemUserRef - `id` string, uuid, required — The unique identifier of the user in the Fordefi platform. - `user_type` 'system', required — The type of the user. - `name` string, required — The name is Fordefi CARE - `approval_request` ApprovalRequest — Represents an approval request for an action in the Fordefi platform - `state` 'created' | 'approved' | 'insufficient_approvers' | 'auto_approved' | 'failed', required — Represents the whole approval request state - `required_groups` integer, required — The number of required approval groups. - `approval_groups` ApprovalRequestGroup[], required — A list of the possible approvers from different groups. - `quorum_size` integer, required — The number of approvers required to approve the transaction. - `approvers` RequestApprover[], required — A list of the possible approvers. - … - `error_message` string — The error message if the request failed. - ApiUser — Represents an API user in the Fordefi platform. - `id` string, uuid, required — The unique identifier of the object in the Fordefi platform. - `created_at` string, date-time, required — The date and time when the object was created. - `modified_at` string, date-time, required — The date and time when the object was last modified. Any change to any field of the resource is considered a modification. - `user_type` 'api_user', required — The type of the user. - `name` string, required — The name of the user. - `state` 'active' | 'deleted', required — The state of the user. Is one of: - `role` 'admin' | 'trader' | 'viewer', required - `user_groups` UserGroupRef[] — The groups the user belongs to. - `id` string, uuid, required — The unique identifier of user group in the Fordefi platform. - `name` string, required — The name of the user group. - `users_count` integer, required — The number of users in the group. - `admins_count` integer, required — The number of admins in the group. - `state` 'active' | 'deleted', required — Represents a user group state in the Fordefi platform - `pending_addition_to_user_groups` UserGroupRef[] — The groups the user is pending to be added to. - `id` string, uuid, required — The unique identifier of user group in the Fordefi platform. - `name` string, required — The name of the user group. - `users_count` integer, required — The number of users in the group. - `admins_count` integer, required — The number of admins in the group. - `state` 'active' | 'deleted', required — Represents a user group state in the Fordefi platform - `pending_removal_from_user_groups` UserGroupRef[] — The groups the user is pending to be removed from. - `id` string, uuid, required — The unique identifier of user group in the Fordefi platform. - `name` string, required — The name of the user group. - `users_count` integer, required — The number of users in the group. - `admins_count` integer, required — The number of admins in the group. - `state` 'active' | 'deleted', required — Represents a user group state in the Fordefi platform - `allowed_ip_settings` UserAllowedIpSettings, required - `allow_type` 'allow_all' | 'ip_list', required - `ip_list` string[] — The list of IP addresses or CIDR ranges that this user is allowed to make API calls from. This field is only used when allow_type is `ip_list`.e.g. `['192.168.1.1', '192.168.1.0/24']` - `last_active_at` string, date-time — The last date and time when the user was active. - ApiSigner — Represents an API Signer in the Fordefi platform. - `id` string, uuid, required — The unique identifier of the object in the Fordefi platform. - `created_at` string, date-time, required — The date and time when the object was created. - `modified_at` string, date-time, required — The date and time when the object was last modified. Any change to any field of the resource is considered a modification. - `user_type` 'api_signer', required — The type of the user. - `name` string, required — The name of the user. - `state` 'active' | 'onboarding_pending_code_generation' | 'onboarding_pending_activation' | 'deleted', required — The state of the user. Is one of: - `last_keep_alive_at` string, date-time — The last date and time when API Signer sent a keep-alive. - SystemUser — Represents a System User in the Fordefi platform. - `id` string, uuid, required — The unique identifier of the object in the Fordefi platform. - `created_at` string, date-time, required — The date and time when the object was created. - `modified_at` string, date-time, required — The date and time when the object was last modified. Any change to any field of the resource is considered a modification. - `user_type` 'system', required — The type of the user. - `name` string, required — The name of the system user. - `state` 'active', required — The state of the system user can be only active and returned for consistency. ## Other responses - `400` — Bad Request - `401` — Unauthorized User - `403` — Forbidden User - `408` — Request Timeout - `422` — Validation Error - `429` — Rate Limit Exceeded - `500` — Unexpected Error --- [API](https://skmtc.net/fordefi/apis/fordefi-api.md) · [All operations](https://skmtc.net/fordefi/apis/fordefi-api/llms.txt) · [OpenAPI document](https://skmtc-service-staging.skmtc.workers.dev/v1/apis/fordefi/fordefi-api/versions/8014fd69ea17/schema)