Management API reference

Use the management API to create and manage sites, placements and experiments in a programmatic manner. It allows you to integrate Bidboost directly into your backoffice tools and minimize manual work.

We have an interactive Swagger UI to inspect endpoints, payloads, and response schemas for the management API. There you can also download the OpenAPI schema which you can use to generate client code for your desired programming language.

Open Swagger UI

Authentication

Log into the API using the email address and password we provided to you. The response JSON object contains a bearerToken field that must be sent as the Authorization header for subsequent requests. The token expires after one day.

curl -X POST "https://api.bidboost.net/user/login" \
  -H "Content-Type: application/json" \
  -d '{"emailAddress":"[email protected]","password":"your-password"}'

Verify authentication by listing sites with the bearer token.

curl -X GET "https://api.bidboost.net/site?offset=0&limit=5" \
  -H "Authorization: Bearer YOUR_TOKEN_HERE"