Super Admin Orgs

List all organizations

Changed on

Retrieve paginated organizations in the system. Only accessible to users with the super admin system role.

get/super-admin/orgs

Request

  • The document declares no server URL.
  • Auth: none declared

Query parameters

status'active' | 'archived' | 'all'
searchstring
Example:Acme

Search organizations by name.

limitnumber
Example:25

Maximum number of organizations to return (default: 50).

offsetnumber

Number of organizations to skip (default: 0).

Response

Successfully retrieved organizations for the super admin.

Example response

{
  "data": [
    {
      "id": "123e4567-e89b-12d3-a456-426614174000",
      "name": "Acme Corporation",
      "createdAt": "2024-01-15T10:30:00Z"
    }
  ],
  "pagination": {
    "limit": 50,
    "total": 150
  }
}

Changes

  • 366e2075c239Revision changes
    • info

      added the required property // to the response with the status

  • 06cf3af07f8aRevision changes
    • info

      added the new optional query request parameter status

    • info

      added the required property // to the response with the status