Skip to main content
GET
/
v1
/
admin
/
settings
/
operator
Get operator settings
curl --request GET \
  --url https://{operatorDomain}/v1/admin/settings/operator \
  --header 'Authorization: Bearer <token>'
{
  "profile": {
    "legalName": "<string>",
    "tradingName": "<string>",
    "email": "jsmith@example.com",
    "phone": "<string>",
    "address": {},
    "logoUrl": "<string>"
  },
  "paymentInstructions": {
    "bankTransfer": {},
    "notes": "<string>"
  },
  "paymentDefaults": {
    "currency": "EUR",
    "depositPercent": 123,
    "balanceDueDays": 123
  }
}

Authorizations

Authorization
string
header
required

Staff session or API token issued by your Voyant app.

Response

200 - application/json

Operator settings

profile
object
paymentInstructions
object
paymentDefaults
object