API Access


Authorization: Bearer <api_key>


General requests to the API endpoint will return JSON.

The response will be wrapped in "data" and match the shape of the original query.

curl(1) example:

EDUFLOW_API_KEY=<api_key> \
  curl \
  -H 'Content-Type: application/json' \
  -H "Authorization: Bearer ${EDUFLOW_API_KEY}" \
  -X POST \
  -d '{"query": "{institution {name}}"}' \


{"data":{"institution":{"name":"Test institution"}}}

Session-based / GraphiQL

Institution administrators that are logged into Eduflow can access the API endpoint and query through the graphql interface.

When logged in, go directly to

If you access via browser, the GraphQL endpoint will show GraphiQL

To open GraphiQL's sidebar, mouseover an object in the query and click an object inside a tooltip, or clicking "Doc":

GraphiQL works with both session-based (logged into and by passing authorization headers.

Last updated