Skip to documentation
AdQuestDocs

Platform API

Read your platform’s public configuration and branding.

On this page

Get platform config

GET/platform/config

Returns the published branding and configuration for the platform that owns the API key.

Authentication: Public API key (X-AdQuest-Platform-Key).

Request, cURL
curl "https://api.adquest.batriders.ir/api/v1/platform/config" \
  -H "X-AdQuest-Platform-Key: YOUR_PUBLIC_API_KEY"

200 The platform’s name and published theme.

Response 200
{
  "status": true,
  "code": "OK",
  "message": "Platform config",
  "data": {
    "name": "Subway Sample",
    "theme": {
      "colors": {
        "primary": "#FB6514"
      }
    },
    "public_id": "63e1528f-0214-439e-b233-a9b99c54fb77"
  }
}

Get public config

GET/platform/public-config/{publicId}

Returns the same configuration by the platform’s public ID. The hosted embed uses it to load your branding. No credentials are needed.

Authentication: None.

ParameterInTypeDescription
publicId requiredpathstringThe platform’s UUID, from your Embed URL.
Request, cURL
curl "https://api.adquest.batriders.ir/api/v1/platform/public-config/63e1528f-0214-439e-b233-a9b99c54fb77"

200 The platform’s name and published theme. The response is never cached.

404 The ID is not a UUID, or no accepted and active platform has it.

Response 404
{
  "status": false,
  "message": "Platform not found",
  "data": null
}

Next steps

Something unclear, missing or wrong here? Tell us