v1

latestOpenAPI 3.0.32026-07-24148824715.6 KB
Users

Get accounts for a user

Returns a list of accounts for a given user.

You need the "View users" permission to use this endpoint.

get/v2/users/{user_identifier}/accounts

Path parameters

user_identifierstring uuid required

The identifier of the user whose accounts you'd like to retrieve.

Query parameters

name_containsstring

Filter user by name.

client_identifierstring uuid

The identifier of the client whose accounts you'd like to retrieve.

page_numberinteger

The page of results returned within the response.

page_sizeinteger

The amount of results returned within the response.

Response

OK

firststring required

The url with parameters of the first page

nextstring

The url with parameters of the next page, null if there are no more pages

prevstring

The url with parameters of the previous page, null if current page_number is 1

selfstring

The url with parameters of the current page

total_countinteger nullable

Total number of items.

Example response

{
  "accounts": [
    {
      "client_identifier": "00000000-0000-0000-0000-000000000000",
      "identifier": "00000000-0000-0000-0000-000000000000",
      "name": "A Bank Retail",
      "roles": [
        {
          "assigned_at": "2023-01-01T10:10:10.000Z",
          "name": "Admin",
          "user_role_identifier": "00000000-0000-0000-0000-000000000000"
        }
      ]
    }
  ],
  "total_count": 60
}