Get all Users
GET /obp/v7.0.0/users
OBPv6.0.0-getUsers Roles: CanGetAnyUser User
Get all users, optionally filtered.
All query parameters are optional and may be combined.
User Authentication is Required. The User must be logged in. The Application must also be authenticated.
CanGetAnyUser entitlement is required.
Possible custom url parameters for pagination:
- limit=NUMBER ==> default value: 50
- offset=NUMBER ==> default value: 0
eg1:?limit=100&offset=0
URL encoding: query parameter values containing &, =, +, #, %, or spaces must be URL-encoded (e.g. + → %2B, space → %20). Most other characters (including @ in emails) are safe unencoded, but encoding is always permitted.
- provider (if null ignore) - filter by identity provider, exact match
- username (if null ignore) - filter by username, exact match
- email (if null ignore) - filter by email, exact match (may return multiple users — duplicate emails are allowed in OBP by design)
- user_id (if null ignore) - filter by user_id, exact match
- locked_status (if null ignore) - "active" or "locked"
- is_deleted (default: false)
- role_name (if null ignore) - filter by entitlement/role name e.g. CanCreateAccount
- bank_id (if null ignore) - when used with role_name, filter entitlements by bank_id
- sort_by (if null ignore) - sort by field; allowed values: created_date, email, provider, updated_date, user_id, username
- sort_direction (if null defaults to DESC) - "asc" or "desc" (case-insensitive)
When sort_by is omitted, results are ordered by insertion order ascending (stable pagination).
Returns an empty list (not 404) when no users match.
JSON response body fields (26)
- account_id
- 8ca8a7e4-6d02-40e3-a129-0b2bf89de9f0
- bank_id
- gh.29.uk
- felixsmith@example.com
- entitlement_id
- entitlements
- first_name
- Tom
- is_deleted
- is_deleted
- is_locked
- is_locked
- last_name
- Smith
- list
- provider
- ETHEREUM
- provider_id
- role_name
- text
- type
- user_id
- 9ca9a7e4-6d02-40e3-a129-0b2bf89de9b1
- username
- felixsmith
- users
- user list
- view_id
- owner
- agreements
- agreements
- created_date
- created_date
- email_validated
- email_validated
- last_marketing_agreement_signed_date
- last_marketing_agreement_signed_date
- last_used_locale
- last_used_locale
- updated_date
- updated_date
- views
Example success response
{
"users": [
{
"user_id": "9ca9a7e4-6d02-40e3-a129-0b2bf89de9b1",
"email": "felixsmith@example.com",
"provider_id": "Chris",
"provider": "http://127.0.0.1:8080",
"username": "felixsmith",
"first_name": "Tom",
"last_name": "Smith",
"entitlements": {
"list": [
{
"entitlement_id": "6fb17583-1e49-4435-bb74-a14fe0996723",
"role_name": "CanQueryOtherUser",
"bank_id": "gh.29.uk"
}
]
},
"views": {
"list": [
{
"bank_id": "gh.29.uk",
"account_id": "8ca8a7e4-6d02-40e3-a129-0b2bf89de9f0",
"view_id": "owner"
}
]
},
"agreements": [
{
"type": "",
"text": ""
}
],
"is_deleted": false,
"last_marketing_agreement_signed_date": "1100-01-01T00:00:00Z",
"is_locked": false,
"created_date": "1100-01-01T00:00:00Z",
"updated_date": "1100-01-01T00:00:00Z",
"email_validated": true,
"last_used_locale": "en_GB"
}
]
}Possible errors (6)
- OBP-20001: User not logged in. Authentication is required!
- OBP-20006: User is missing one or more roles:
- OBP-10042: sort_by parameter value is not in the global whitelist. Allowed values are: account_id, amount, app_name, balance, bank_id, card_id, consent_id, consumer_id, correlation_id, counterparty_id, created_date, currency, customer_id, date, developer_email, duration, email, full_name, http_status_code, implemented_by_partial_function, implemented_in_version, label, name, provider, short_name, status, transaction_id, updated_date, url, user_id, username, verb.
- OBP-10043: sort_by value is not allowed for this endpoint.
- OBP-10023: obp_sort_direction parameter can only take two values: DESC or ASC!
- OBP-50000: Unknown Error.