Skip to main content

Documentation Index

Fetch the complete documentation index at: https://v4-docs.alfaone.app/llms.txt

Use this file to discover all available pages before exploring further.

​
Base URL

All API requests should be made to: 
https://alfaone.app/api/v1

​
Authentication

All endpoints require an API key passed in the x-api-key header: 
curl -X GET "https://alfaone.app/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"
    }
  ],
  "pagination": {
    "page": 1,
    "limit": 20,
    "total": 1,
    "totalPages": 1
  }
}

​
Error Response

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

​
HTTP Status Codes

Status CodeDescription
200Success - Request completed successfully
201Created - Resource was created successfully
400Bad Request - Invalid or missing request parameters
401Unauthorized - Invalid or missing API key
404Not Found - The requested resource doesn’t exist
409Conflict - The resource already exists
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

Send assessment invites and track their status

Tags

Create, update, and manage organization tags

​
Pagination

All list endpoints support pagination through query parameters. Results are returned alongside a pagination metadata object.

​
Query Parameters

ParameterTypeDefaultDescription
pageinteger1Page number (1-indexed)
limitinteger20Items per page (min 1, max 100)
sortstringvariesField to sort by (see each endpoint for allowed values)
orderstringdescSort direction: asc or desc

​
Example Request

curl -X GET "https://alfaone.app/api/v1/assessments?page=2&limit=10&sort=name&order=asc" \
  -H "x-api-key: ak_live_your_api_key_here"

​
Paginated Response

Every list response includes a pagination object alongside the resource array: 
{
  "assessments": [
    {
      "id": "uuid",
      "name": "Assessment Name"
    }
  ],
  "pagination": {
    "page": 2,
    "limit": 10,
    "total": 87,
    "totalPages": 9
  }
}
FieldDescription
pageThe current page number
limitThe number of items per page
totalThe total number of items across all pages
totalPagesThe total number of pages

​
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.