# Giftbit API

> Automatically order digital rewards and deliver them to your recipients with the Giftbit REST API.

- [Introduction](https://giftbit.mintlify.app/index.md): Giftbit's REST API allows you to automatically order rewards and send them to your recipients. Delivery can be handled either by links that are intergrated into another system’s workflow or by emails that are sent through the Giftbit system.
- [Environments and URLs](https://giftbit.mintlify.app/guides/environments.md): Giftbit provides separate Testbed and Production environments, each with its own API root and account settings.
- [Authentication](https://giftbit.mintlify.app/guides/authentication.md): Authenticate with the Giftbit API by sending your API token prefixed by the word Bearer (case sensitive) and a space in the “Authorization” HTTP header.
- [HTTP success and error codes](https://giftbit.mintlify.app/guides/response-codes.md): Your API integration should always check the HTTP response code to ensure correct handling of success and error conditions.
- [Getting started](https://giftbit.mintlify.app/guides/getting-started.md): Choose a delivery method, decide between customized-list and full-catalog rewards, and structure your Giftbit integration.
- [Going live](https://giftbit.mintlify.app/guides/going-live.md): Move your integration from the Testbed to Production.
- [API overview](https://giftbit.mintlify.app/guides/api-reference.md): A definitive list of Giftbit API endpoints, grouped by resource.
- [Ping](https://giftbit.mintlify.app/api-reference/ping/ping.md): Provides a way to test your authentication and check the health of the Giftbit API.
- [List brands](https://giftbit.mintlify.app/api-reference/brands/list-brands.md): Returns a list of reward brands available from Giftbit, including the `brand_code` and an allowed price to include in your calls to `/campaign`, `/direct_links`, or `/embedded`.
- [Retrieve brand](https://giftbit.mintlify.app/api-reference/brands/retrieve-brand.md): Retrieves extended information about the specified brand.
- [List regions](https://giftbit.mintlify.app/api-reference/regions/list-regions.md): Returns a list of the regions that can be used to filter results from `/brands`.
- [Create order](https://giftbit.mintlify.app/api-reference/email-orders/create-order.md): Places an order for one or more rewards.
- [Retrieve order by ID](https://giftbit.mintlify.app/api-reference/email-orders/retrieve-order-by-id.md): Retrieves the status and information about the specified order.
- [Create order](https://giftbit.mintlify.app/api-reference/email-orders/create-order.md): Places an order for one or more rewards.
- [Retrieve link URLs](https://giftbit.mintlify.app/api-reference/shortlink-orders/retrieve-link-urls.md): Retrieves the URLs for a link-based order (shortlink or direct link). The URLs are ready after a short delay following the successful response from `/campaign` or `/direct_links`. We recommend polling every 5 minutes until the URLs are ready.
- [Create direct link order](https://giftbit.mintlify.app/api-reference/direct-link-orders/create-direct-link-order.md): Places an order for direct link rewards — URLs that go straight to rewards with minimal Giftbit branding and no template content or message. The reward URLs are generated and returned immediately in the response.
- [Create embedded reward](https://giftbit.mintlify.app/api-reference/embedded-rewards/create-embedded-reward.md): Places a reward order for a specific brand for immediate in-app delivery in your app or website. The response includes a `gift_link` URL where the recipient reveals their reward code.
- [Retrieve funding information](https://giftbit.mintlify.app/api-reference/funds/retrieve-funding-information.md): Retrieves a real-time overview of your account balance by currency.
- [Add funds through credit card](https://giftbit.mintlify.app/api-reference/funds/add-funds-through-credit-card.md): Tops up your account balance with a credit card payment. Use the web interface to place a credit card on file for each currency you plan to fund. The success response provides your updated account balance.
- [List rewards](https://giftbit.mintlify.app/api-reference/rewards/list-rewards.md): Retrieves the details and status of rewards you've previously ordered through `/campaign`, `/direct_links`, or `/embedded`. All date/time fields are in Pacific Standard Time.
- [Retrieve reward](https://giftbit.mintlify.app/api-reference/rewards/retrieve-reward.md): Retrieves a single reward by its uuid.
- [Resend reward](https://giftbit.mintlify.app/api-reference/rewards/resend-reward.md): Triggers another delivery attempt for the reward. Rewards delivered in-app via `/embedded` are not eligible for resending.
- [Cancel reward](https://giftbit.mintlify.app/api-reference/rewards/cancel-reward.md): Cancels the reward. Once a reward has been claimed by the recipient it cannot be cancelled, and rewards delivered in-app via `/embedded` are not eligible for cancellation.

## OpenAPI Specs

- [openapi](/api-reference/openapi.yaml)