API Explorer 993 endpoints

Get My Organisations

GET /obp/v7.0.0/my/organisations

OBPv7.0.0-getMyOrganisations No role required Organisation

Get the Organisations you are a member of, each with your member_role in it.

An Organisation is a company or team that uses the APIs, for example a fintech, and owns Consumers. Its members are admins or members. Members may act for the Organisation's Consumers without a Role: read them, their usage, Scopes and API Product Subscriptions, and subscribe them. Admins also change the Organisation and its members, and move Consumers into or out of it.

Its bank_id is the space that administers it, and staff Roles for Organisations are held there. An Organisation you create for yourself is at SYS. Only staff with CanCreateOrganisationAtOneBank at a bank create one there. The bank_id is not a legal relationship with that bank, which is what a Customer is. An Organisation is not a Tenant either: a Tenant is a customer of the operator of this instance.

Authentication is Required.

User Authentication is Required. The User must be logged in. The Application must also be authenticated.

JSON response body fields (11)
bank_id
gh.29.uk
created_at
created_at
created_by_user_id
description
Description of the object. Maximum length is 2000. It can be any characters here.
member_role
member_role
name
ACCOUNT_MANAGEMENT_FEE
organisation_id
8ca8a7e4-6d02-48e3-a029-0b2bf89de9f0
organisations
organisations
status
updated_at
updated_at
website
www.openbankproject.com
Example success response
{
  "organisations": [
    {
      "organisation_id": "8ca8a7e4-6d02-48e3-a029-0b2bf89de9f0",
      "bank_id": "SYS",
      "name": "Example Fintech Ltd",
      "description": "Builds payment apps.",
      "website": "https://fintech.example.com",
      "status": "active",
      "member_role": "admin",
      "created_by_user_id": "9ca9a7e4-6d02-40e3-a129-0b2bf89de9b1",
      "created_at": "1100-01-01T00:00:00Z",
      "updated_at": "1100-01-01T00:00:00Z"
    }
  ]
}
Possible errors (2)
  • OBP-20001: User not logged in. Authentication is required!
  • OBP-50000: Unknown Error.
Implemented by OBPv7.0.0 getMyOrganisations