Get Banner by ID

Prev Next
Get
/api/v1/banners/{id}

Gets the banner to be shown to the authenticated user.

Header parameters
X-Auth-Token
stringRequired

The authorization token of the user.

Example9HqLlyZOugoStsXCUfD_0YdwnNnunAJF8V47U3QHXSq
X-User-Id
stringRequired

The user ID of the user.

ExampleaobEdbYhXfu5hkeqG
Path parameters
id
stringRequired

The banner ID.

ExampleByehQjC44FwMeiLbX
Query parameters
platform
stringRequired

The platform rendering the banner.

Exampleweb
Responses
200
Success Example
{
  "banners": [],
  "success": true
}
Expand All
object
banners
Array of object
object
success
boolean
400

Bad Request

Invalid Params
{
  "success": false,
  "error": "must have required property 'platform' [invalid-params]",
  "errorType": "invalid-params"
}
object
success
boolean
error
string
errorType
string
401

Unauthorized

Authorization Error
{
  "status": "error",
  "message": "You must be logged in to do this."
}
object
status
string
message
string