Get company settings

Return company-level settings and credit balance.

Required scope

The access token must carry this scope. A token missing it gets 403 Forbidden. Grant them to an API client under Dev Tools → API, to an assistant or CLI sign-in when you approve or edit it under Dev Tools, and to a teammate under Employee → Permissions.

settings:read

GETExample request

curl

curl -X GET "https://www.pxb.app/api/public/v1/settings/company" \
  -H "Authorization: Bearer your_access_token"

200Example response

json

{
  "message": "Company settings retrieved successfully!",
  "content": {
    "settings": {
      "id": "company_789",
      "reference": "Acme Inc",
      "ipWhitelistEnabled": false,
      "creditBalance": 12500
    }
  }
}

In the console

The same thing done by hand, for anyone comparing the API against the screen they already use.

Settings → Company → General

/settings/company/general