Skip to main content
GET
/
promotions
/
{id}
Show a promotion
curl --request GET \
  --url https://api.pocketflows.com/promotions/{id} \
  --header 'Authorization: Basic <encoded-value>'
{
  "id": "<string>",
  "name": "<string>",
  "start_time": "<string>",
  "end_time": "<string>",
  "points_multiplier": 123,
  "description": "<string>",
  "image_url": "<string>"
}

Authorizations

Authorization
string
header
required

Basic authentication header of the form Basic <encoded-value>, where <encoded-value> is the base64-encoded string username:password.

Path Parameters

id
string
required

The ID of the promotion

Response

200 - application/json

The retrieved Promotion object

id
string
required

The ID of the promotion

name
string
required

Name of the promotion

start_time
string
required

Start time of the promotion

end_time
string
required

End time of the promotion

points_multiplier
integer
required

Multiplier applied to earned points

description
string
required

Description of the promotion

image_url
string | null
required

URL of the promotion image

I