> ## Documentation Index
> Fetch the complete documentation index at: https://giftbit.mintlify.site/llms.txt
> Use this file to discover all available pages before exploring further.

# List regions

> Returns a list of the regions that can be used to filter results from `/brands`.

Regions are also used to request a Full Catalog reward from `/campaign` or `/direct_links`.




## OpenAPI

````yaml /api-reference/openapi.yaml get /regions
openapi: 3.1.0
info:
  title: Giftbit API
  version: v1
  description: >
    Giftbit's REST API lets you automatically order rewards and send them to
    your

    recipients. Delivery can be handled either by links that integrate into
    another

    system's workflow, or by emails sent through the Giftbit system.


    Authenticate every request with a bearer token in the `Authorization`
    header.

    Only an HTTP `200` means success; all non-`200` responses share a common
    error body.
  contact:
    name: Giftbit Support
    email: testbed@giftbit.com
    url: https://www.giftbit.com/api-documentation
servers:
  - url: https://api-testbed.giftbit.com/papi/v1
    description: Testbed
  - url: https://api.giftbit.com/papi/v1
    description: Production
security:
  - bearerAuth: []
tags:
  - name: Ping
    description: Test your authentication and check the health of the Giftbit API.
  - name: Brands
    description: List reward brands and retrieve extended information about a single brand.
  - name: Regions
    description: List the regions used to filter brands and request Full Catalog rewards.
  - name: Email Orders
    description: Order one or more rewards delivered to recipients by Giftbit email.
  - name: Shortlink Orders
    description: Order branded shortlink rewards that include a customized landing page.
  - name: Direct Link Orders
    description: >-
      Order minimally branded direct link rewards returned immediately in the
      response.
  - name: Embedded Rewards
    description: >-
      Order a single in-app reward for immediate delivery in your app or
      website.
  - name: Funds
    description: Retrieve your account balance and top it up with a credit card payment.
  - name: Rewards
    description: List, retrieve, resend, and cancel individual rewards.
paths:
  /regions:
    get:
      tags:
        - Regions
      summary: List regions
      description: >
        Returns a list of the regions that can be used to filter results from
        `/brands`.


        Regions are also used to request a Full Catalog reward from `/campaign`
        or `/direct_links`.
      operationId: list-regions
      responses:
        '200':
          description: A list of regions has been retrieved.
          content:
            application/json:
              schema:
                type: object
                properties:
                  regions:
                    type: array
                    items:
                      $ref: '#/components/schemas/Region'
                  info:
                    $ref: '#/components/schemas/Info'
              example:
                regions:
                  - id: 1
                    name: Canada
                    image_url: >-
                      https://s3-us-west-2.amazonaws.com/staticimageskiind/flags/CA@3x.png
                  - id: 2
                    name: USA
                    image_url: >-
                      https://s3-us-west-2.amazonaws.com/staticimageskiind/flags/US@3x.png
                  - id: 3
                    name: Global
                    image_url: >-
                      https://s3-us-west-2.amazonaws.com/staticimageskiind/flags/GLBL@3x.png
                  - id: 4
                    name: Australia
                    image_url: >-
                      https://s3-us-west-2.amazonaws.com/staticimageskiind/flags/AU@3x.png
                info:
                  code: INFO_RETRIEVED_REGIONS
                  name: Regions Retrieved
                  message: A list of regions has been retrieved.
components:
  schemas:
    Region:
      type: object
      properties:
        id:
          type: integer
        name:
          type: string
        image_url:
          type: string
    Info:
      type: object
      description: Status information returned on successful requests.
      properties:
        code:
          type: string
          description: An enum-style status code for the request.
        name:
          type: string
          description: Human-readable status name.
        message:
          type: string
          description: Request-context-specific message.
  securitySchemes:
    bearerAuth:
      type: http
      scheme: bearer
      description: Send your API token prefixed by `Bearer ` in the `Authorization` header.

````