Get institution by id front-door

Get institution by id

get/institutions/{id}

Request

Base URL: http://localhost:8080
URL: http://localhost:8080/institutions/{id}
Auth: none required

Path parameters

idstring required

The ID of the institution to fetch details of

Example:10

Response

OK response.

iconstring required

A URL to an icon for the institution

idstring required

The id of the institution

industry'banking' | 'energy' required

The industry of the institution e.g. “banking” or “energy”

is_accessibleboolean

Whether this institution is accessible by the teamID. Determines if institution can be used

logostring required

A URL to the logo of the institution

namestring required

The name of the institution

priorityinteger required

The order that this institution will appear in during an auth session

Example response

{
  "icon": "https://eastpaclogo.com.au/eastpac-icon.svg",
  "id": "22",
  "industry": "banking",
  "is_accessible": true,
  "logo": "https://eastpaclogo.com.au/eastpac.svg",
  "name": "Eastpac",
  "priority": 1,
  "status": {
    "connections": {
      "status": "OUTAGE"
    }
  }
}

Changes

No recorded changes to this operation across all 1 revision of this API.