Returns one account from your own part of the hierarchy: its name, where it sits, its contact and billing details, the domains it answers on, and the feature settings it has turned on.
object.config.active_settings names the settings configured on the account; the example below shows a representative handful rather than the whole list. The values themselves are read through the account settings endpoints.
Security
default
- Mock serverhttps://developer.rosterfy.com/_mock/api-docs/openapi/api/v2/account/{id}
- Your Rosterfy accounthttps://example.rosterfy.com/api/v2/account/{id}
curl -i -X GET \
'https://developer.rosterfy.com/_mock/api-docs/openapi/api/v2/account/{id}' \
-H 'Authorization: Bearer <YOUR_TOKEN_HERE>' \
-H 'Rosterfy-Platform: admin'Response
{ "object": { "id": 20101, "parent_id": 1, "account_type_id": 3, "path": "1/20101", "name": "Example Organisation", "config": { … }, "meta": [], "visibility_rules": [], "status": "approved", "status_reason": null, "sort_order": 0, "start_timestamp": null, "end_timestamp": null, "notes": null, "contact_firstname": null, "contact_lastname": null, "contact_email": null, "contact_phone": null, "support_manager_email": "support.manager@example.com", "allow_deletion_request": 1, "organization_type": null, "contract_start_date": "2026-06-09", "contract_end_date": "2027-06-09", "billing_contact_email": "billing@example.com", "billing_support_email": "billing.support@example.com", "is_enabled": 1, "additional_billing_support_email": "billing.additional@example.com", "delete_requested_at": null, "is_archived": 0, "trial_ends_at": null, "can_erase": 0, "deleted_at": null, "is_erased": 0, "created_at": "2026-06-09T05:33:32.000000Z", "updated_at": "2026-06-09T07:08:01.000000Z", "domain": [ … ] }, "nice": { "rrn": "rrn:local:1:account:20101", "address": "No Address", "address_oneline": "No Address", "account_type_id": 3, "account_type_id:value": 3, "account_type_id:array": 3, "allow_deletion_request": "Yes", "contact_firstname": "", "contact_lastname": "", "contact_phone:qr_code_value": "", "contact_phone": "", "contact_phone:raw": "", "contract_end_date": "Jun 9, 2027", "contract_end_date__dayofweek": "Wednesday", "contract_start_date": "Jun 9, 2026", "contract_start_date__dayofweek": "Tuesday", "name": "Example Organisation", "notes": "", "organization_type": null, "organization_type:value": null, "organization_type:array": null, "status": "Approved", "status:value": "approved", "status:array": "approved", "status_reason": "", "created_at": "2026-06-09 05:33:32", "url": "https://example.rosterfy.com/", "branding_name": "Example Organisation", "branding_subtitle": null, "branding_logo": null, "branding_logo_mono": null, "branding_logo_stacked": null, "branding_banner": null, "branding_favicon": null, "branding_description": null, "branding_primary_color": "#3131c7", "branding_complimentary_color": null, "branding_secondary_color": "#38b6ff", "register": false, "organisation_contact": " ", "has_subaccount_approved_email_template": false, "has_subaccount_rejected_email_template": false, "parent_account_name": "Example Parent Organisation" }, "relations": { "current_user_checkpoint": { … }, "parent": [], "account": [] }, "permissions": { "read": true, "update": false, "delete": false, "apply": false, "apply_error": "Subaccount does not allow User to join", "view_subaccount_selection_menu": false }, "attributes": {} }