index

GET /api/v1/accounts/:account_id/posters

List posters

Returns all posters for the store. Optionally filter by card or active status.

Parameters

Name Type Required Description
account_id Must be a number. Required

Store (account) ID
card_id Must be a number. Optional

Filter posters belonging to a specific card
active Must be a String Optional

When present, return only active posters

Error Codes

Code Description
401 Unauthorized – invalid or missing API token
404 Store not found

Returns

Code: 200

An array of poster objects

Name Type Required Description
id Must be a Integer Required

Unique poster ID
account_id Must be a Integer Required

Parent store ID
card_id Must be a Integer Required

Loyalty card customers are signed up to
title Must be a String Required

Heading printed on the poster

(nil allowed)
paper_size Must be a String Required

Paper size the poster is laid out for
primary_color Must be a String Required

Hex colour for the poster background

(nil allowed)
secondary_color Must be a String Required

Hex accent colour

(nil allowed)
text_color Must be a String Required

Hex colour for poster text

(nil allowed)
contact_collection_mode Must be a String Required

Which contact fields appear on the public signup form: ‘email_and_phone’, ‘email_only’, or ‘phone_only’
collect_email Must be one of: true, false, 1, 0. Required

Whether the public signup form collects email
collect_phone Must be one of: true, false, 1, 0. Required

Whether the public signup form collects phone number
require_email Must be one of: true, false, 1, 0. Required

Whether email is required when it is collected
require_phone Must be one of: true, false, 1, 0. Required

Whether phone number is required when it is collected
require_birthday Must be one of: true, false, 1, 0. Required

Whether date of birth is required on the public signup form
minimum_age Must be a Integer Required

Minimum customer age required for signup

(nil allowed)
active Must be one of: true, false, 1, 0. Required

Whether the public signup URL is live
signup_url Must be a String Required

Public URL the QR code points at
display_url Must be a String Required

URL of the on screen version of the poster
qr_code_url Must be a String Required

URL encoded in the QR code
created_at Must be a String Required

ISO 8601 creation timestamp
updated_at Must be a String Required

ISO 8601 last-update timestamp