Get all Entitlement Requests
GET /obp/v7.0.0/entitlement-requests
OBPv3.0.0-getAllEntitlementRequests Roles: CanGetEntitlementRequestsAtOneBank(per bank),CanGetEntitlementRequestsAtAnyBank RoleEntitlementUser
Get all Entitlement Requests
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.
- sort_direction=ASC/DESC ==> default value: DESC.
eg2:?limit=100&offset=0&sort_direction=ASC
- from_date=DATE => example value: 1970-01-01T00:00:00.000Z. NOTE! The default value is one year ago (1970-01-01T00:00:00.000Z).
- to_date=DATE => example value: 2026-10-21T01:45:42.891Z. NOTE! The default value is now (2026-10-21T01:45:42.891Z).
Date format parameter: yyyy-MM-dd'T'HH:mm:ss.SSS'Z'(1100-01-01T01:01:01.000Z) ==> time zone is UTC.
eg3:?sort_direction=ASC&limit=100&offset=0&from_date=1100-01-01T01:01:01.000Z&to_date=1100-01-01T01:01:01.000Z
User Authentication is Required. The User must be logged in. The Application must also be authenticated.
JSON response body fields (14)
Example success response
{
"entitlement_requests": [
{
"entitlement_request_id": "6fb17583-1e49-4435-bb74-a14fe0996723",
"user": {
"user_id": "9ca9a7e4-6d02-40e3-a129-0b2bf89de9b1",
"email": "felixsmith@example.com",
"provider_id": "Chris",
"provider": "http://127.0.0.1:8080",
"username": "felixsmith",
"entitlements": {
"list": [
{
"entitlement_id": "6fb17583-1e49-4435-bb74-a14fe0996723",
"role_name": "CanQueryOtherUser",
"bank_id": "gh.29.uk"
}
]
}
},
"role_name": "CanQueryOtherUser",
"bank_id": "gh.29.uk",
"created": "1100-01-01T00:00:00Z"
}
]
}Possible errors (4)
- OBP-20001: User not logged in. Authentication is required!
- OBP-50200: Connector cannot return the data we requested.
- OBP-50000: Unknown Error.
- OBP-20006: User is missing one or more roles: