GET
/api/public/v1/boosts/{boostId}Get a Boost
One Boost: its area, what it does, and when it was turned on.
Required scope
The access token must carry this scope. A token missing it gets 403 Forbidden. Grant them to an API client under Dev Tools → API, to an assistant or CLI sign-in when you approve or edit it under Dev Tools, and to a teammate under Employee → Permissions.
boosts:read
Path Parameters
| Name | Type | Required | Description |
|---|---|---|---|
boostId | string | Required | Boost ID. |
GETExample request
curl
curl -X GET "https://www.pxb.app/api/public/v1/boosts/{boostId}" \
-H "Authorization: Bearer your_access_token"200Example response
json
{
"message": "Boost retrieved successfully!",
"content": {
"boost": {
"id": "bst_2211",
"companyId": "cmp_abc123",
"type": "SUPPORT",
"name": "Support Automation",
"description": "Answers customer questions, resolves the common issues and routes the rest to your team.",
"createdAt": "2026-05-02T09:00:00.000Z",
"updatedAt": "2026-08-29T09:00:00.000Z"
}
}
}In the console
The same thing done by hand, for anyone comparing the API against the screen they already use.
Boosts
/boosts