Uptimeify Docs
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/:organizationPublicId remains supported for compatibility.
  • The plural org-less alias GET /api/organizations is also supported.
  • Global admins need an active organization context in the authenticated session for the org-less route.
  • Billing fields, including the quota* fields and pendingQuotaChange, are only present for an organization admin or a global admin. Other members receive the response without them.

Response

{
  "id": 1,
  "name": "My Org",
  "companyName": "My Company GmbH",
  "street": "Sample St. 1",
  "postalCode": "12345",
  "city": "Berlin",
  "country": "DE",
  "vatId": "DE123456789",
  "billingEmail": "billing@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 (AGB § 10.5). It is null when nothing is scheduled, which is the normal case.

FieldMeaning
effectiveAtThe first instant at which the new plan applies: the next UTC month start for a monthly billing cycle, the end of the paid term for a yearly one.
quotaWebsitesLimitThe monitor limit that will apply from then on. null means no limit.
quotaSmsIncludedThe included SMS allowance that will apply from then on.
quotaMonthlyPriceCentsThe 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 session when no organization can be derived from the current session/token
  • 401 Unauthorized when you are not logged in
  • 403 Forbidden when you cannot access the organization

On this page