Configurations

The Configurations API endpoint retrieves a list of available overrides for launches with Scalemate.

Endpoint Information

URL: https://api.scalemate.co/api/external/configs Method: GET

Headers

Content-Type: application/json
X-Api-Key: <YOUR_API_KEY>

You can generate the API Key at the Settings page under API Key section

Parameters

platform_type	Enum (Optional) "facebook" | "tiktok"	Filters template list by platform type

Example cURL Request

curl -X GET "https://api.scalemate.co/api/external/v1/configs" \
  -H "X-Api-Key: <YOUR_API_KEY>"

Example Response

{
    "configs": [
        {
            "id": 6,
            "name": "Engligh 18+ All gender",
            "description": "Descriptive overview about the configuration.",
            "platform_type": "facebook",
            "data": {
                "age_max": 65,
                "age_min": 34,
                "genders": [
                    "1"
                ],
                "locales": [
                    "6",
                    "3",
                    "2",
                    "59",
                    "1",
                    "4",
                    "31",
                    "15"
                ],
                "pixel_id": <PIXEL_ID>,
                "ad_account_id": <AD_ACCOUNT_ID>,
                "geo_locations": {
                    "countries": [
                        "US",
                        "CA",
                        "GB",
                        "AT",
                        "BE",
                        "CO",
                        "HR",
                        "DK",
                        "DO",
                        "EG",
                        "FI"
                    ]
                }
            }
        }
    ]
}