Skip to content
API reference
/
/
Get current account confi...

Get current account configuration

Request

Returns the configuration a client needs in order to present the organisation correctly: how the account identifies itself, the settings that shape the experience, the wording it uses for everyday concepts, and the locales it offers. Which account answers is determined by the subdomain the request is made against, so no identifier is passed.

The response has five parts. account is the organisation itself - its identifier, its parent if it sits under one, its status and a set of capability flags a client uses to decide what to show. settings is the account's configuration as key/value pairs, keyed by a section:name string. terms is the account's own vocabulary, so an organisation that calls its people "Members" rather than "Volunteers" is reflected here and a client should take its labels from this block rather than hard-coding them. locales lists the languages offered. extras carries client-side integration configuration.

The settings block is large and account-specific - a configured organisation returns several hundred entries - so the example shows a representative selection rather than the full set. Read the keys you need by name and ignore the rest; entries are added over time and a key being absent means the account has not set it.

Despite being grouped with the current-user endpoints, this describes the organisation and not the caller. Nothing in the response varies by user.

Security
default
Headers
Rosterfy-Platformstring
curl -i -X GET \
  https://developer.rosterfy.com/_mock/api-docs/openapi/api/v2/account/data \
  -H 'Authorization: Bearer <YOUR_TOKEN_HERE>' \
  -H 'Rosterfy-Platform: admin'

Responses

Bodyapplication/json
accountobject
settingsobject
termsobject
localesArray of objects
extrasobject
Response
{
  "account": {
    "id": 20101,
    "rrn": "rrn:local:20101:account:20101",
    "parent_id": null,
    "parent_url": null,
    "parent_account_name": null,
    "status": "approved",
    "can_request_deletion": true,
    "has_support_email": false,
    "delete_requested_at": null,
    "allow_family": true,
    "is_archived": false,
    "has_latest_eula": false,
    "has_payment_integration": false,
    "is_locked": false,
    "is_trial": false,
    "has_seek_volunteer_integration": false
  },
  "settings": {
    "general:available_locales": [ … ],
    "general:locale": "en-AU",
    "general:timezone": "Australia/Melbourne",
    "general:location": [ … ],
    "users:register": 1,
    "email:from_email": "noreply@example.com",
    "email:from_name": "Example Organisation"
  },
  "terms": {
    "rosterfy": "Rosterfy",
    "admin": "Admin",
    "portal": "Portal",
    "user": "User",
    "users": "Users",
    "event": "Event",
    "events": "Events",
    "shift": "Shift",
    "shifts": "Shifts",
    "account": "Account",
    "accounts": "Accounts",
    "subaccount": "Subaccount",
    "subaccounts": "Subaccounts"
  },
  "locales": [
    { … },
    { … },
    { … }
  ],
  "extras": {
    "datadog": { … },
    "thresholds": [],
    "level_1_account_rrn": "rrn:local:20101:account:20101",
    "intercom_app_id": "example0",
    "messaging_api_key": "example0key0",
    "messaging_channel_limit": 10000,
    "show_channel_count": false
  }
}