Enables the retrieval of application linking information; this shows what institutions are linked to the current application. This means that the application specified (by appID) can access data associated with the specified institutions.

Institution information can be collected via the GET /institutions REST end-point.

Resource URL

https://api.ideasystem.org/v1/app/appID/links/institutions

Response

The response will be an HTTP 200 with a JSON body. The body will be a list of institution IDs.

If the given application ID cannot be found, an HTTP 404 (Not Found) will be returned. If there is an issue with the backend, a HTTP 500 (Internal Server Error) is returned. If the application name/key you are using doesn't have access to this REST end-point, you will get a 403 (Forbidden) error.

Example

This request will get the list of linked institutions for an application with ID 1234.

Request

GET /v1/app/1234/links/institutions

Response (as JSON)

HTTP 200
[
    10123, 14569, 7843
]