Organisation

Read organisation type

GET/v4/onboard/platform/organisation/type/{typeId}

Returns an organisation type (a sector), for example the type of your organisation. The sector of Read organisation is the type of the organisation type. A platform admin of the installation manages the organisation types; each organisation can read them.

Language of the request sample

curl 'https://demo-api.igrant.io/v4/onboard/platform/organisation/type/6ae2bf741c3dadfeb27982e1' \
  -H 'Authorization: ApiKey <your-api-key>'

{
  "organisationType": {
    "id": "6ae2bf741c3dadfeb27982e1",
    "type": "Banking",
    "imageId": "",
    "imageUrl": ""
  }
}

Authorizations

Authorizationstringheaderrequired
Your API key with the prefix ApiKey: ApiKey <your-api-key>. Get an API key.
Scope:organisation:read

Path parameters

typeIdstringrequired
The ID of the organisation type.
Example:"6ae2bf741c3dadfeb27982e1"

Response

application/json

The organisation type.

organisationTypeobject