API ReferenceUsers

Api Accounts Invitations List

GET/POST /api/accounts/invitations/ List all invitations with optional filters. Requires superadmin access. POST is for filtering (not creation) - follows POST-for-Filtering pattern. Uses standard filter format via `filters` payload key. Query Parameters: - page (int): Page number (default: 1) - page_size (int): Items per page (default: 20, max: 100) - sort_by (str): Field to sort by (default: -sent_at) Filters (in request body under "filters" key): - organization_id: Filter by organization ID - email: Filter by invited email (icontains, equals, startswith) - accepted_at__isnull: Filter pending (true) vs accepted (false)

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