Skip to main content

​
Before you start

You’ll need:
  • An Edpire organization account (request access if you don’t have one yet)
  • No pre-existing assessments required — you’ll create one in this guide

​
Step 1 — Sign in and create an assessment

  1. Go to https://edpire.com/org
  2. Sign in (or request access)
  3. Navigate to Assessments
  4. Click Create assessment

​
Step 2 — Add a simple question

Create the simplest possible working example:
  1. Add a question
  2. Enter a prompt (e.g., “What is 2 + 2?”)
  3. Go to the Choices tab
  4. Add multiple options
  5. Mark the correct answer
You can enhance questions later using Blanks, images, or multiple exercises — but keep it simple for now.
Use the preview panel on the left to test your question instantly.

​
Step 3 — Publish and share

  1. Click Publish
  2. Copy the share link
Example: 
https://{your-slug}.edpire.com/take/{shareCode}?learner_ref=123
Parameters:
  • {your-slug} — your organization subdomain
  • {shareCode} — unique identifier for the assessment
  • learner_ref — your internal user ID (recommended)
Open the link in a new tab, complete the assessment, and submit your answers.

​
Step 4 — Create an API key

  1. Go to https://edpire.com/org/integrations
  2. Click Create key
  3. Name it (e.g., Quickstart Key)
  4. Select the read:assessments and read:results scopes
  5. Copy and store it securely
Your API key is shown only once. Store it in an environment variable immediately.

​
Step 5 — Verify the API

List your assessments: 
curl https://edpire.com/api/v1/assessments \
  -H "Authorization: Bearer edp_live_<your-key>"
You should see the assessment you just created.

​
Step 6 — Fetch results

Retrieve results for your assessment: 
curl --request GET \
  --url "https://edpire.com/api/v1/assessments/{id}/results?page=1&limit=50" \
  --header "Authorization: Bearer edp_live_<your-key>"
This returns submissions, scores, and learner references.

​
What you’ve done

  • Created an assessment
  • Shared it with a learner
  • Submitted a response
  • Retrieved results via API
You now have a complete end-to-end integration.

​
What’s next?

  • Store assessment IDs and learner_ref in your system
  • Build dashboards or analytics on top of results
  • Explore advanced integrations like webhooks or SDK components