Skip to main content
Admins

List admins

Returns all admins for your organization.

GET
/v2/admins

This endpoint returns all admins at once (typically a small list). No pagination is supported.

Response Format

Returns a list object with:

  • object - Always "list"
  • data - Array of admin objects
  • nextCursor - Always null

Admin Object

Each admin includes:

  • id - Unique admin identifier
  • name - Admin's display name
  • email - Admin's email address
  • picture - Profile picture URL
  • roleId - ID of the role assigned to this admin

Authorizations

Authorizationstringheaderrequired

API key as Bearer token. Use: Authorization: Bearer sk_...

Headers

Featurebase-Versionenum<string>header

API version for this request. Defaults to your organization's configured API version if not specified.

Available options: 2026-08-19.orbit, 2026-01-01.nova, 2025-12-12.clover
Example: 2026-08-19.orbit

Response

application/json

Success

dataobject[]required

Array of admins

nextCursorstring | nullrequired

Cursor for fetching the next page (cursor-based pagination)

objectenum<string>required

Object type identifier

Available options: list
Example: list
paginationobject

Pagination metadata for page-based requests

Still need help? Ask the team