Skip to main content

​
Base URL

All API requests should be made to: 
https://api.alfaone.com/api/v1
For local development: 
http://localhost:3000/api/v1

​
Authentication

All endpoints require an API key passed in the x-api-key header: 
curl -X GET "https://api.alfaone.com/api/v1/assessments" \
  -H "x-api-key: ak_live_your_api_key_here"
See the Authentication page for more details.

​
Response Format

All responses are returned in JSON format. Successful responses will include the requested data, while error responses will include an error field with a descriptive message.

​
Success Response

{
  "assessments": [
    {
      "id": "uuid",
      "name": "Assessment Name",
      ...
    }
  ]
}

​
Error Response

{
  "error": "Error message describing what went wrong"
}

​
HTTP Status Codes

Status CodeDescription
200Success - Request completed successfully
401Unauthorized - Invalid or missing API key
404Not Found - The requested resource doesn’t exist
429Too Many Requests - Rate limit exceeded
500Internal Server Error - Something went wrong on our end

​
Available Endpoints

Assessments

List, retrieve, and view questions for assessments

Members

Access organization member information

Invites

Manage assessment invites and track status

​
Pagination

Currently, all list endpoints return the complete set of results. Pagination support will be added in a future API version.

​
Versioning

The API is versioned via the URL path (/api/v1/). When breaking changes are introduced, a new version will be released while maintaining support for previous versions during a deprecation period.