Admins

List Admins

List business admins with filtering and pagination.

Query parameters:

  • email__eq: Filter by email (exact match)
  • email__contains: Filter by email (contains text)
  • business_id__eq: Filter by business ID
  • created_at__gte: Filter by created date (greater than or equal)
  • created_at__lte: Filter by created date (less than or equal)
  • sort: Sort fields (e.g., "-created_at" for descending, "email" for ascending)
  • page: Page number (default: 1)
  • limit: Items per page (default: 10, max: 100)

Supported filter operators:

  • eq: Equals
  • ne: Not equals
  • gt: Greater than
  • gte: Greater than or equal
  • lt: Less than
  • lte: Less than or equal
  • in: In list (comma-separated values)
  • nin: Not in list (comma-separated values)
  • contains: Contains text (case-insensitive)
  • startswith: Starts with text (case-insensitive)
  • endswith: Ends with text (case-insensitive)

Example: /api/v1/admins?email__contains=admin&sort=-created_at&page=1&limit=10

Note: password_hash field is automatically excluded from responses for security.

get/api/v1/admins

Query parameters

pageinteger
limitinteger

Response

Successful Response

itemsobject[] required
totalinteger required
has_nextboolean required
has_prevboolean required

Changes

No recorded changes to this endpoint across all 1 revision of this API.