Setup

List users

Fetches all users associated with the corporate or consumer identity the logged-in user belongs to.

get/users

Request

  • Base URL: https://sandbox.weavr.io/multi
  • URL: https://sandbox.weavr.io/multi/users
  • Auth: HTTP bearer and API key in header api-key

Query parameters

offsetinteger

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.

limitinteger
Example:25

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

activeboolean

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

emailstring email

Email Address of the user

Example:alex@example.com

Filter by the email address of the user.

tagstring

Filter by the managed account/card tag. The exact tag must be provided, as wildcards are not supported. Leave out to fetch all managed accounts/card.

rolesUserPredefinedRole[]

Filter users by role. Multiple roles use OR logic.

Response

Success

countinteger

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

responseCountinteger

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

Example response

{
  "users": [
    {
      "id": "987654321",
      "identity": {
        "type": "CONSUMER",
        "id": "123456789"
      },
      "name": "Alex",
      "surname": "Smith",
      "email": "alex@example.com",
      "mobile": {
        "countryCode": "+44",
        "number": "7700900123"
      },
      "active": true,
      "dateOfBirth": {
        "year": 1990,
        "month": 1,
        "day": 1
      },
      "tag": "customer-123",
      "countryOfResidence": "GB",
      "locale": "en-GB",
      "brand": "Acme"
    }
  ]
}

Changes

No recorded changes to this operation across all 1 revision of this API.