API ReferenceUsers

Api Accounts List

GET/POST /api/accounts/ List and create platform accounts. Requires superadmin access (JWT or API key). GET: List all accounts with summarized info (paginated) POST: Create a new account with email, password, and organization Request body for POST: { "email": "user@example.com", // required "password": "securepass123", // required, min 8 chars "organization_name": "Org Name", // optional, default "Test Org" "create_organization": true, // optional, default true "is_active": true // optional, default true }

Authentication

AuthorizationBearer
JWT access token or Respan API key

Query parameters

pageintegerOptional
A page number within the paginated result set.
page_sizeintegerOptional
Number of results to return per page.

Response

countinteger
resultslist of objects
nextstring or nullformat: "uri"
previousstring or nullformat: "uri"
total_countinteger
current_filtersobject

Pydantic model for FilterParamDict. A dictionary that maps metric names to their filter parameters.

Each key is a metric name (str), and each value can be:

  • A single MetricFilterParamPydantic (one condition)
  • A List[MetricFilterParamPydantic] (multiple conditions for same metric)
  • A FilterBundlePydantic (nested filter bundle with connector)

Note: Uses extra=“allow” for dynamic metric name fields. The pydantic_extra annotation tells Pydantic what types to expect for extra fields, and generates typed additionalProperties in JSON Schema.

filters_dataobject