Sign in
Getting started

Postman Collection

Explore every Giftronaut API endpoint interactively using our official Postman collection. Import it in seconds and start making authenticated requests against the sandbox environment.

Download the collection

Click the button below to download the Giftronaut API Postman collection JSON file. Once downloaded, import it into Postman using File → Import.

What's included

The collection covers all public endpoints across every resource domain:

  • Orders — List orders, get order, create branded/choice card orders, cancel, resend
  • Recipients — CRUD operations on your organization's address book
  • Recipient Groups — Create groups, manage members, use groups in bulk sends
  • Catalog — Browse branded card products and choice card designs
  • Balance — Check your current balance and view the ledger
  • Campaigns — Create and execute reusable gift card campaigns
  • Email Templates — Manage the look and feel of delivery emails

Each request includes a pre-populated example body where applicable, and all endpoints are grouped by domain for easy navigation.

Setting up your environment

The collection uses Postman variables so you only need to set your credentials once. After importing, create a new Postman Environment (or edit the included one) and fill in the following variables:

Variable
Description
Example
base_url
API base URL for the target environment
https://api.giftronaut.com
client_id
Your app's Client ID
app_xxxxxxxxxxxxxxxx
client_secret
Your app's Client Secret
secret_xxxxxxxxxxxxxxxx
access_token
Filled automatically by the Auth request
leave blank
Tip: Run the POST /oauth/token request first. The collection's pre-request script automatically stores the returned access_token in your environment, so every subsequent request is pre-authorized without any manual copy-paste.

Sandbox vs Production

All collection examples use https://api.giftronaut.com as the base URL. Sandbox and Production are determined by the credentials you provide — not by a different domain. Use your Sandbox app's Client ID and Secret to test safely, then swap in your Production credentials when you are ready to go live.

Warning: Production requests deduct from your real balance and send actual gift card emails. Always test against the sandbox first.

See Sandbox vs Production for a full explanation of the differences between the two environments.