Eduframe Organization - API (v1)
Download OpenAPI specification:
The Eduframe Organization API is organized around REST and is formatted in JSON. We try to keep the amount of changes to the API to a minimum but it is possible that it is changed.
For authenticating through Eduframe Organization API we use OAuth2 token. The user needs an API key to send together with the request as Bearer <api key> in the authorization header. If there are requests that require authentication a 403 Forbidden error or a 404 Not Found error will be returned.
If a value is missing, it will be represented as null.
Boolean parameters can be provided as true, false, 1, or 0. In responses, boolean values are always returned as true or false.
Timestamps are returned in ISO 8601 format: yyyy-MM-ddTHH:mm:ss.SSSZ. When sending dates or times, use the same ISO 8601 format.
For each request the appropriate HTTP verbs are used. GET is used for retrieving resources, POST is used for creating resources, PUT is used for updated resources with partial JSON data. A PUT request can accept one or more parameters to update the resource; the parameters that are not updated keep their original values, DELETE is used for deleting resources.
Requests that return multiple items will be paginated to 25 items by default. You can set a custom per-page amount with the per_page query parameter (with a maximum of 100). Navigation to the next page can be done following the Link header. This header includes pagination information. For example: Link: <https://api.eduframe.nl/api/organization/contacts?cursor=eyJpZCI6MjV9&per_page=25>; rel="prev", <https://api.eduframe.nl/api/organization/contacts?cursor=eyJpZCI6NTB9&per_page=25>; rel="next"
In the Eduframe Organization API the general codes are: the 2xx range indicates a successful request; the 4xx range indicates an error representing the failure of giving the provided information (e.g. a required parameter was omitted, a certain include/filter is not allowed, unauthorized access, etc.); the 5xx range indicates an error with the Eduframe's servers.
To protect platform stability and ensure fair usage, Eduframe APIs enforce rate limits. Use standard techniques — client-side throttling, caching, and responsible retries — to avoid being throttled.
Limits
- Per IP address: 500 requests per 5-minute window. Requests authenticated with a valid access token are exempt from the per-IP limit.
- Per access token (Bearer): 500 requests per 5-minute window. The limit applies per application.
When a limit is exceeded
When a client exceeds a limit, the API returns 429 Too Many Requests. The response includes a Retry-After header telling you how many seconds to wait before retrying.
Some of our API endpoints and/or attributes require a specific feature flag to be enabled for your Eduframe environment before it can be used.
Endpoints and attributes that rely on a feature flag are marked with a badge, for example:
Get all contacts Beta
Authorizations:
query Parameters
| cursor | string Note: It's almost never necessary to use this parameter directly, the URL
should be retrieved from the The cursor used to fetch the next result set. |
| per_page | integer [ 1 .. 100 ] Default: 25 Example: per_page=10 The number of results to retrieve for this page. |
Responses
Response samples
- 200
- 400
- 401
- 403
- 404
- 429
- 500
[- {
- "id": 0,
- "first_name": "string",
- "middle_name": "string",
- "last_name": "string",
- "email": "user@example.com"
}
]