PilotFoxDocs

List all organizations

GET
/api/v1/admin/orgs

Every organization of the instance with its member and live site counts, newest first, a page at a time (meta.nextCursor); search matches part of the name or slug, ignoring case.

Requires a signed-in system administrator (session cookie). API keys and share links: 401; other signed-in users: 403.

Authorization

session
cookie__Secure-pilotfox.session_token<token>

The web app's sign-in session, acting with the user's role; named pilotfox.session_token on an instance whose PUBLIC_URL is plain http. Under /api/v1, a POST, PUT, PATCH or DELETE carrying a cookie must come from the instance's own origin (Origin: PUBLIC_URL or a DASHBOARD_ORIGINS entry; else 403), and a body it carries must be JSON or multipart (else 415).

Query Parameters

search?string
Length1 <= length <= 100
cursor?string
Lengthlength <= 2200
limit?integer
Range1 <= value <= 200
Default50

Response Body

OK

application/json
  1. response
data*array<>
meta*
Example Request
curl -X GET 'https://pilotfox.app/api/v1/admin/orgs'
Example Response200
{  "data": [    {      "id": "string",      "name": "string",      "slug": "string",      "createdAt": "string",      "members": 0,      "sites": 0    }  ],  "meta": {    "nextCursor": "string"  }}