Institutions
6 routes. Paths are relative to https://api.intersink.com/v1.
- GET/institutionsGet all institutions
- POST/institutionsCreate a new institution (platform admin)
- GET/institutions/{id}Get a specific institution by ID
- PATCH/institutions/{id}Update an institution (platform admin)
- DELETE/institutions/{id}Delete an institution (platform admin)
- GET/institutions/typesGet all unique institution types
Get all institutions
GET/institutions
Needs a signed-in user (Bearer token or access_token cookie).
Parameters
| Name | Type | Description |
|---|---|---|
| limit | number, query | Minimum 1, maximum 100. |
| offset | number, query | Minimum 0. |
Response
200. The payload in data is not described in the spec yet. List of institutions.
Create a new institution (platform admin)
POST/institutions
Needs a signed-in user (Bearer token or access_token cookie).
Request body application/json
| Field | Type | Description |
|---|---|---|
| namerequired | string | Name of the institution |
| typerequired | string | Type of the institution (e.g., University, School, NGO) |
| status | string | Status of the institution One of: "published", "draft", "archived". |
Response
201. The payload in data is not described in the spec yet. Institution created successfully.
Get a specific institution by ID
GET/institutions/{id}
Needs a signed-in user (Bearer token or access_token cookie).
Parameters
| Name | Type | Description |
|---|---|---|
| idrequired | number, path |
Response
200. The payload in data is not described in the spec yet. Institution details.
Update an institution (platform admin)
PATCH/institutions/{id}
Needs a signed-in user (Bearer token or access_token cookie).
Parameters
| Name | Type | Description |
|---|---|---|
| idrequired | number, path |
Request body application/json
| Field | Type | Description |
|---|---|---|
| name | string | Name of the institution |
| type | string | Type of the institution |
| status | string | Status of the institution One of: "published", "draft", "archived". |
Response
200. The payload in data is not described in the spec yet. Institution updated successfully.
Delete an institution (platform admin)
DELETE/institutions/{id}
Needs a signed-in user (Bearer token or access_token cookie).
Parameters
| Name | Type | Description |
|---|---|---|
| idrequired | number, path |
Response
200. The payload in data is not described in the spec yet. Institution deleted successfully.
Get all unique institution types
GET/institutions/types
Needs a signed-in user (Bearer token or access_token cookie).
Response
200. The payload in data is not described in the spec yet. List of institution types.