Search Team Members

get https://api.cloud.digifi.io/users

The Search Team Members API can be used to get information about your team members.

Query Params

count

number

1 to 100

Defaults to 20

Number of entities to return. Used for pagination implementation. If no value is provided used default 20. Max 100.

offset

number

≥ 0

Number entities to skip. Useful for pagination implementation. Only works if count param is passed

sortField

string

Field to sort by

sortDirection

string

Direction of sort results. asc or desc

string

Search query to perform

permissionGroupId

string

The permission group ID to filter users by.

permissionGroupName

string

The permission group name to filter users by.

isMfaEnabled

string

Whether to filter users by MFA status.

isVerified

string

Whether to filter users by verification status.

statuses

array of strings

The statuses to filter users by.

statuses

ids

array of strings

The IDs to filter users by.

ids

authType

string

The authentication type to filter users by.

Headers

api-version

string

Defaults to 2024-02-26

Responses

Language

Credentials

Header

URL


xxxxxxxxxx
1
curl --request GET \
2
     --url 'https://api.cloud.digifi.io/users?count=20' \
3
     --header 'accept: application/json' \
4
     --header 'api-version: 2024-02-26'

Click Try It! to start a request and see the response here! Or choose an example:

application/json

200Success

400Bad Request

401Unauthorized

404Not Found

500Internal Server Error