portalConfig

Requires permission settings:tenant:read.

Returns your organization's customer portal and buyer app settings: name, branding, which features are on, contact details and store links. Needs settings:tenant:read.

Errors: a failed call returns a GraphQL errors entry, not a field on the result, and data may be null or partial. Read the entry's extensions.code and message; every shape and code is in the Error reference.

Example:

GraphQL

query PortalConfig {
  portalConfig {
    id
    portalName
    resolvedName
    accentColor
    allowDirectOrders
    allowGuestBrowsing
  }
}

cURL

curl -X POST "https://<api-host>/graphql" \
  -H "Content-Type: application/json" \
  -H "Authorization: Bearer $ACCESS_TOKEN" \
  --data @- <<'EOF'
{
  "query": "query PortalConfig {\n  portalConfig {\n    id\n    portalName\n    resolvedName\n    accentColor\n    allowDirectOrders\n    allowGuestBrowsing\n  }\n}"
}
EOF

Response:

{
  "data": {
    "portalConfig": {
      "id": "id",
      "portalName": "string",
      "resolvedName": "string",
      "accentColor": "string",
      "allowDirectOrders": true,
      "allowGuestBrowsing": true
    }
  }
}

portalConfig: PortalConfigResponse!

Type

PortalConfigResponse object

The portal settings, for the admin console.