v1

latestOpenAPI 3.1.02026-08-04751,1671.3 MB
Users

List Users

Get a list of users in the organization.

get/api/v1/users

Query parameters

sort_byUserSortableFields[]
pageinteger
sizeinteger

The number of items per page.

The number of items per page.

skip_countboolean

Whether to skip counting the total number of items.

Whether to skip counting the total number of items.

typesUserType[]

The types of the users to filter on.

The types of the users to filter on.

rolesUserRole[]

The roles of the users to filter on.

The roles of the users to filter on.

statesUserState[]

The states of the users to filter on. Is one of: <ul><li>active: The user can perform all actions in the Fordefi platform.<li>onboarding_pending_code_generation: The user has been approved but still needs to generate a code for the user.<li>onboarding_pending_activation: The user has been generated a code but still needs to activate the account with it.<li>deleted: The user has been deleted.</ul>

The states of the users to filter on. Is one of: <ul><li>active: The user can perform all actions in the Fordefi platform.<li>onboarding_pending_code_generation: The user has been approved but still needs to generate a code for the user.<li>onboarding_pending_activation: The user has been generated a code but still needs to activate the account with it.<li>deleted: The user has been deleted.</ul>

include_deletedboolean

True to include deleted users in the response, False otherwise.

True to include deleted users in the response, False otherwise.

namesstring[]

The names of the users.

The names of the users.

emailsstring[]

The emails of the users.

The emails of the users.

user_idsstring[]

The unique identifiers of the users.

The unique identifiers of the users.

external_idsstring[]

The IDs that you assign to the end user.

The IDs that you assign to the end user.

group_idsstring[]

The unique identifiers of the user groups.

The unique identifiers of the user groups.

group_ids__notstring[]

The unique identifiers of the user groups to exclude.

The unique identifiers of the user groups to exclude.

states_on_groupsUserStateOnGroup[]

The states of the user groups to filter group_ids on. Is one of: <ul><li>active: The user group is active.<li>pending_addition: The user is pending to be added to the group.<li>pending_removal: The user is pending to be removed from the group.</ul>

The states of the user groups to filter group_ids on. Is one of: <ul><li>active: The user group is active.<li>pending_addition: The user is pending to be added to the group.<li>pending_removal: The user is pending to be removed from the group.</ul>

exclude_user_idsstring[]

The user IDs to exclude.

The user IDs to exclude.

Response

Successful Response

totalinteger required
pageinteger required
sizeinteger required