Get organization settings

gethttps://api.expiryedge.com/v1/getOrganizationSettings
any role60/min
Request
curl 'https://api.expiryedge.com/v1/getOrganizationSettings' \
  -H "Authorization: Bearer $EXPIRYEDGE_API_KEY"
Response
{
  "organization": {
    "name": "Northwind Dental",
    "industry": "Healthcare",
    "timezone": "America/Chicago",
    "logo_url": "https://storage.googleapis.com/stylingsphere.appspot.com/organizations/org_northwind/logo/1790517900000_logo.png",
    "website": "https://northwinddental.com",
    "phone": "+1 312 555 0142",
    "address": "200 W Madison St, Chicago, IL",
    "email_sender_name": "Northwind Dental",
    "email_sender_prefix": "reminders",
    "email_sender_identity_enabled": true,
    "email_reminder_mode": "INDIVIDUAL",
    "digest_send_time": "09:00",
    "base_currency": "USD",
    "billing_email": "billing@northwinddental.com",
    "tax_id": {
      "type": "us_ein",
      "value": "12-3456789"
    },
    "setup_checklist_acks": {
      "reminder_sequence": true
    },
    "expiry_form_sections": null,
    "expiry_form_section_order": null
  }
}

Profile, branding, email sender, digest, currency, billing and expiry-form settings of your organization. Errors from this endpoint (including token failures) return 500 with {error, message}.

Returns

200
Organization settings.
  • organizationobjectrequired
    Organization profile and settings. Unset strings come back as ''.

Errors

400
The request is missing required fields or contains invalid values.
401
Missing, expired or invalid bearer token.
404
The record does not exist or is not in your organization.
429
Too many requests for this endpoint from your IP. Wait Retry-After seconds.
500
Unexpected server error. Retry later; quote requestId to support.