List

GET

https://api.icepanel.io/v1/organizations

GET

/v1/organizations

1 import { IcePanelClient } from "@icepanel/sdk";
2 
3 async function main() {
4     const client = new IcePanelClient({
5         apiKey: "YOUR_API_KEY_HERE",
6     });
7     await client.organizations.list({});
8 }
9 main();

1 {
2   "organizations": [
3     {
4       "lineShapeDefault": "curved",
5       "name": "string",
6       "oauthLandscapeWriteEnabled": true,
7       "shareLinkAuthDomains": [
8         "string"
9       ],
10       "shareLinksEnabled": true,
11       "autoInviteDomains": [
12         "string"
13       ],
14       "billingPaymentMethod": true,
15       "createdAt": "2024-01-15T09:30:00Z",
16       "createdBy": "user",
17       "createdById": "string",
18       "id": "string",
19       "plan": "free",
20       "seats": 1.1,
21       "status": "active",
22       "updatedAt": "2024-01-15T09:30:00Z",
23       "updatedBy": "user",
24       "updatedById": "string",
25       "userIds": [
26         "string"
27       ],
28       "users": {},
29       "aiFeatures": {
30         "generateDetailedDescriptions": true,
31         "generateDisplayDescriptions": true,
32         "generateDraftSummary": true,
33         "generateObjectSummary": true
34       },
35       "aiFeaturesEnabled": true,
36       "aiModel": "gpt-5",
37       "billingCurrency": "usd",
38       "billingCycle": "monthly",
39       "billingEmail": "string",
40       "experiments": {},
41       "language": "en-US",
42       "billingCollectionMethod": "charge",
43       "billingMonthlyCost": 1.1,
44       "cancelAt": "2024-01-15T09:30:00Z",
45       "canceledAt": "2024-01-15T09:30:00Z",
46       "planEndsAt": "2024-01-15T09:30:00Z",
47       "trialEndsAt": "2024-01-15T09:30:00Z"
48     }
49   ]
50 }

Authentication

X-API-Keystring

API key authentication

AuthorizationBearer

Bearer token authentication

Query parameters

adminbooleanOptional

list all organizations on the platform

Response

organizationslist of objects

Errors

400

Bad Request Error

401

Unauthorized Error

403

Forbidden Error

404

Not Found Error

422

Unprocessable Entity Error

500

Internal Server Error