API Conventions

Requests

Send JSON requests to POST https://api.creatora.io/graphql. Use the Authentication headers for Administrator requests.

Values

Type	Format
`UUID`	A UUID string, such as an ID returned by another request.
`DateTime`	Unix time in milliseconds, as an integer.
`Long`	A JSON integer.
`Map`	A JSON object on output; input values are not supported.
`Unit`	`"OK"` on output.

Pagination

Use limit to keep reads bounded. courses accepts limit without a continuation cursor. students, customOffers, and orders accept pagination with limit and beforeMillis. beforeMillis selects records created strictly before the supplied Unix-millisecond timestamp.

Errors

A response can include both data and errors, even with HTTP 200.

Authorization error: check your token.
Unknown field or invalid operation: check the request against the Complete API schema.

Mutation retries

After a timeout, check whether the write completed before retrying. For Course creation and Course access grants, follow the recovery instructions in the corresponding Recipe.

Send a request with cURL

Replace <JWT> with your token:

curl 'https://api.creatora.io/graphql' \
  -H 'Content-Type: application/json' \
  -H 'Authorization: Bearer <JWT>' \
  --data '{"query":"{ platform { id host } }"}'

Get started

Recipes

API guides

Requests

Values

Errors

Mutation retries

​Requests

​Values

​Pagination

​Errors

​Mutation retries

Requests

Values

Pagination

Errors

Mutation retries