Skip to content
/
Get all users

Get all users

Request

Fetches all authorised users associated with the buyer that the logged-in user belongs to.

Required user role: ADMIN

Security
apiKey and authToken
Query
offsetinteger, (int32), >= 0

The offset value for paging, indicating the initial item number to be returned from the data set satisfying the given criteria. Leave out to fetch the first page of results.

Default:0
limitinteger, (int32), [ 1 .. 100 ]

The limit of the results for paging, starting at the offset. Limit is always capped at 100.

Default:100
activeboolean

Filter for active or deactivated users. Leave out to fetch all users.

emailstring, (email)

Filter for users with the specified email address.

curl -i -X GET \
  'https://sandbox.weavr.io/payment-run/v1/users?offset=0&limit=100&active=true&email=user%40example.com' \
  -H 'Authorization: Bearer <YOUR_JWT_HERE>' \
  -H 'api-key: YOUR_API_KEY_HERE'

Responses

Success

Headers
request-refstringrequired

A request identifier. Providing this reference when contacting our support team will help us investigate your query.

Bodyapplication/json
usersArray of objects

The list of users matching the criteria specified.

countinteger, (int32)

The total number of records (excluding the paging limit).

responseCountinteger, (int32)

The total number of records returned in this response (always capped at 100).

Response
{
  "users": [
    { … }
  ],
  "count": 0,
  "responseCount": 0
}