Organization
Get Organization Details
Returns details of the organization from your authenticated session.
GET /api/organization
Example (cURL)
BASE_URL="https://uptimeify.io"
TOKEN="<your-api-token>"
curl -X GET "$BASE_URL/api/organization" \
-H "Authorization: Bearer $TOKEN" \
-H "Accept: application/json"Notes:
- The organization is derived automatically from your authenticated session or API token.
- The legacy route
GET /api/organizations/:organizationPublicIdremains supported for compatibility. - The plural org-less alias
GET /api/organizationsis also supported. - Global admins need an active organization context in the authenticated session for the org-less route.
emailLanguage(de,enorda) is the organization's default language for e-mails and text messages. Every member receives it; customers without their ownemailLanguagefollow it.contractEmailis the address that receives notices of changes to the terms, the DPA and the privacy policy;nullmeans every admin receives them. Like the other billing fields it is only returned to organization admins and global admins, other members receivenull.- Billing fields, including the billing address (
companyName,street,postalCode,city,country),vatId, thequota*fields andpendingQuotaChange, are only present for an organization admin or a global admin. Other members receive the response without them.
Response
{
"id": 1,
"name": "My Org",
"emailLanguage": "de",
"companyName": "My Company GmbH",
"street": "Sample St. 1",
"postalCode": "12345",
"city": "Berlin",
"country": "DE",
"vatId": "DE123456789",
"billingEmail": "billing@deinkunde.com",
"contractEmail": "contracts@deinkunde.com",
"createdAt": "2023-01-01T00:00:00.000Z",
"pendingQuotaChange": {
"effectiveAt": "2026-08-01T00:00:00.000Z",
"quotaWebsitesLimit": 25,
"quotaSmsIncluded": 100,
"quotaMonthlyPriceCents": 6900
}
}pendingQuotaChange describes a quota reduction that has been requested but does not take effect until the end of the current billing period (a reduction requested with quotaChangeEffective: "period_end", the default). It is null when nothing is scheduled, which is the normal case.
| Field | Meaning |
|---|---|
effectiveAt | The first instant at which the new plan applies: for a monthly billing cycle the start of the next month (00:00 Europe/Berlin from 1 January 2027, e.g. 2027-01-31T23:00:00.000Z for 1 February; 00:00 UTC for reductions scheduled until 31 December 2026), the end of the paid term for a yearly one. |
quotaWebsitesLimit | The monitor limit that will apply from then on. null means no limit. |
quotaSmsIncluded | The included SMS allowance that will apply from then on. |
quotaMonthlyPriceCents | The monthly price that will apply from then on, in cents. |
While a change is pending, the organization's own quota* fields still describe the current, higher plan, that is the point of the clause, and billing continues at that plan for the whole period. Use Cancel Scheduled Quota Change to call it off, or Update Organization to raise the plan instead.
Common errors
400 Organization ID is required in the authenticated sessionwhen no organization can be derived from the current session/token401 Unauthorizedwhen you are not logged in403 Forbiddenwhen you cannot access the organization