Campfire API
Programmatically create and manage curriculum and assessment content in your workspace.
These legacy docs are copies from what originally was stored in our Notion site. We're building a more capable set of API docs (above) that will ultimately replace this legacy documentation.
Access & Content Type
Host: api.examspark.com
Content-Type: application/json
Authorization
The REST API is currently only intended for Server-Server communication. Do not
send your api-secret
to the client’s browser. The request must go through your
server where you handle user authentication before forwarding the request to us.
This REST API requires an Authorization header that contains a Basic
Authentication value. Traditionally this value is a Base64 representation of
username:password
. In this case, swap username
→ api-key
and password
→
api-secret
. See Basic
Authentication
for more information.
Example
If your api-key
is foo
and api-secret
is bar
, your header value would be:
Authorization: Basic Zm9vOmJhcg==
Pagination
List-oriented API routes often return more results than can fit into a single
payload and must therefore be paginated. Responses with a nextToken
indicate
there are more results to return in subsequent pages. Pass start
as a query
parameter, using the value of the nextToken
in order to return the next page
of results.