Thanx Metadata API

Look up merchants, locations, and scopes.

Operations 3

GET /partner/metadata/merchants Get Merchants #
GET /partner/metadata/locations Get Locations #
GET /partner/metadata/scopes Get Scopes #

Documentation

Specifications

Schemas & Data

📊
JSONSchema
https://raw.githubusercontent.com/api-evangelist/thanx/refs/heads/main/json-schema/consumer-api-authorization-schema.json
📊
JSONSchema
https://raw.githubusercontent.com/api-evangelist/thanx/refs/heads/main/json-schema/consumer-api-birth-date-schema.json
📊
JSONSchema
https://raw.githubusercontent.com/api-evangelist/thanx/refs/heads/main/json-schema/consumer-api-card-envelope-schema.json
📊
JSONSchema
https://raw.githubusercontent.com/api-evangelist/thanx/refs/heads/main/json-schema/consumer-api-card-schema.json
📊
JSONSchema
https://raw.githubusercontent.com/api-evangelist/thanx/refs/heads/main/json-schema/consumer-api-gift-card-schema.json
📊
JSONSchema
https://raw.githubusercontent.com/api-evangelist/thanx/refs/heads/main/json-schema/consumer-api-location-schema.json
📊
JSONSchema
https://raw.githubusercontent.com/api-evangelist/thanx/refs/heads/main/json-schema/consumer-api-pagination-schema.json
📊
JSONSchema
https://raw.githubusercontent.com/api-evangelist/thanx/refs/heads/main/json-schema/consumer-api-purchase-schema.json
📊
JSONSchema
https://raw.githubusercontent.com/api-evangelist/thanx/refs/heads/main/json-schema/consumer-api-reward-envelope-schema.json
📊
JSONSchema
https://raw.githubusercontent.com/api-evangelist/thanx/refs/heads/main/json-schema/consumer-api-reward-schema.json
📊
JSONSchema
https://raw.githubusercontent.com/api-evangelist/thanx/refs/heads/main/json-schema/consumer-api-user-envelope-schema.json
📊
JSONSchema
https://raw.githubusercontent.com/api-evangelist/thanx/refs/heads/main/json-schema/consumer-api-user-input-schema.json
📊
JSONSchema
https://raw.githubusercontent.com/api-evangelist/thanx/refs/heads/main/json-schema/consumer-api-user-schema.json
📊
JSONStructure
https://raw.githubusercontent.com/api-evangelist/thanx/refs/heads/main/json-structure/consumer-api-authorization-structure.json
📊
JSONStructure
https://raw.githubusercontent.com/api-evangelist/thanx/refs/heads/main/json-structure/consumer-api-birth-date-structure.json
📊
JSONStructure
https://raw.githubusercontent.com/api-evangelist/thanx/refs/heads/main/json-structure/consumer-api-card-envelope-structure.json
📊
JSONStructure
https://raw.githubusercontent.com/api-evangelist/thanx/refs/heads/main/json-structure/consumer-api-card-structure.json
📊
JSONStructure
https://raw.githubusercontent.com/api-evangelist/thanx/refs/heads/main/json-structure/consumer-api-gift-card-structure.json
📊
JSONStructure
https://raw.githubusercontent.com/api-evangelist/thanx/refs/heads/main/json-structure/consumer-api-location-structure.json
📊
JSONStructure
https://raw.githubusercontent.com/api-evangelist/thanx/refs/heads/main/json-structure/consumer-api-pagination-structure.json
📊
JSONStructure
https://raw.githubusercontent.com/api-evangelist/thanx/refs/heads/main/json-structure/consumer-api-purchase-structure.json
📊
JSONStructure
https://raw.githubusercontent.com/api-evangelist/thanx/refs/heads/main/json-structure/consumer-api-reward-envelope-structure.json
📊
JSONStructure
https://raw.githubusercontent.com/api-evangelist/thanx/refs/heads/main/json-structure/consumer-api-reward-structure.json
📊
JSONStructure
https://raw.githubusercontent.com/api-evangelist/thanx/refs/heads/main/json-structure/consumer-api-user-envelope-structure.json
📊
JSONStructure
https://raw.githubusercontent.com/api-evangelist/thanx/refs/heads/main/json-structure/consumer-api-user-input-structure.json
📊
JSONStructure
https://raw.githubusercontent.com/api-evangelist/thanx/refs/heads/main/json-structure/consumer-api-user-structure.json
📊
JSONSchema
https://raw.githubusercontent.com/api-evangelist/thanx/refs/heads/main/json-schema/partner-api-campaign-input-schema.json
📊
JSONSchema
https://raw.githubusercontent.com/api-evangelist/thanx/refs/heads/main/json-schema/partner-api-campaign-schema.json
📊
JSONSchema
https://raw.githubusercontent.com/api-evangelist/thanx/refs/heads/main/json-schema/partner-api-campaign-variant-input-schema.json
📊
JSONSchema
https://raw.githubusercontent.com/api-evangelist/thanx/refs/heads/main/json-schema/partner-api-issuance-job-schema.json
📊
JSONSchema
https://raw.githubusercontent.com/api-evangelist/thanx/refs/heads/main/json-schema/partner-api-partner-user-schema.json
📊
JSONStructure
https://raw.githubusercontent.com/api-evangelist/thanx/refs/heads/main/json-structure/partner-api-campaign-input-structure.json
📊
JSONStructure
https://raw.githubusercontent.com/api-evangelist/thanx/refs/heads/main/json-structure/partner-api-campaign-structure.json
📊
JSONStructure
https://raw.githubusercontent.com/api-evangelist/thanx/refs/heads/main/json-structure/partner-api-campaign-variant-input-structure.json
📊
JSONStructure
https://raw.githubusercontent.com/api-evangelist/thanx/refs/heads/main/json-structure/partner-api-issuance-job-structure.json
📊
JSONStructure
https://raw.githubusercontent.com/api-evangelist/thanx/refs/heads/main/json-structure/partner-api-partner-user-structure.json
📊
JSONSchema
https://raw.githubusercontent.com/api-evangelist/thanx/refs/heads/main/json-schema/loyalty-api-account-schema.json
📊
JSONSchema
https://raw.githubusercontent.com/api-evangelist/thanx/refs/heads/main/json-schema/loyalty-api-basket-input-schema.json
📊
JSONSchema
https://raw.githubusercontent.com/api-evangelist/thanx/refs/heads/main/json-schema/loyalty-api-basket-item-schema.json
📊
JSONSchema
https://raw.githubusercontent.com/api-evangelist/thanx/refs/heads/main/json-schema/loyalty-api-basket-schema.json
📊
JSONSchema
https://raw.githubusercontent.com/api-evangelist/thanx/refs/heads/main/json-schema/loyalty-api-loyalty-reward-schema.json
📊
JSONSchema
https://raw.githubusercontent.com/api-evangelist/thanx/refs/heads/main/json-schema/loyalty-api-payment-schema.json
📊
JSONSchema
https://raw.githubusercontent.com/api-evangelist/thanx/refs/heads/main/json-schema/loyalty-api-points-product-schema.json
📊
JSONStructure
https://raw.githubusercontent.com/api-evangelist/thanx/refs/heads/main/json-structure/loyalty-api-account-structure.json
📊
JSONStructure
https://raw.githubusercontent.com/api-evangelist/thanx/refs/heads/main/json-structure/loyalty-api-basket-input-structure.json
📊
JSONStructure
https://raw.githubusercontent.com/api-evangelist/thanx/refs/heads/main/json-structure/loyalty-api-basket-item-structure.json
📊
JSONStructure
https://raw.githubusercontent.com/api-evangelist/thanx/refs/heads/main/json-structure/loyalty-api-basket-structure.json
📊
JSONStructure
https://raw.githubusercontent.com/api-evangelist/thanx/refs/heads/main/json-structure/loyalty-api-loyalty-reward-structure.json
📊
JSONStructure
https://raw.githubusercontent.com/api-evangelist/thanx/refs/heads/main/json-structure/loyalty-api-payment-structure.json
📊
JSONStructure
https://raw.githubusercontent.com/api-evangelist/thanx/refs/heads/main/json-structure/loyalty-api-points-product-structure.json

Other Resources

🔗
Overlay
https://raw.githubusercontent.com/api-evangelist/thanx/refs/heads/main/overlays/thanx-metadata-overlay.yaml
🔗
SDKs
https://github.com/thanx/thanx-sdk-ios
🔗
SDKs
https://github.com/thanx/thanx-sdk-android
🔗
ErrorCodes
https://docs.thanx.com/consumer/usage/errors
🔗
Examples
https://raw.githubusercontent.com/api-evangelist/thanx/refs/heads/main/examples/consumer-api-authorization-example.json
🔗
Examples
https://raw.githubusercontent.com/api-evangelist/thanx/refs/heads/main/examples/consumer-api-birth-date-example.json
🔗
Examples
https://raw.githubusercontent.com/api-evangelist/thanx/refs/heads/main/examples/consumer-api-card-envelope-example.json
🔗
Examples
https://raw.githubusercontent.com/api-evangelist/thanx/refs/heads/main/examples/consumer-api-card-example.json
🔗
Examples
https://raw.githubusercontent.com/api-evangelist/thanx/refs/heads/main/examples/consumer-api-gift-card-example.json
🔗
Examples
https://raw.githubusercontent.com/api-evangelist/thanx/refs/heads/main/examples/consumer-api-location-example.json
🔗
Examples
https://raw.githubusercontent.com/api-evangelist/thanx/refs/heads/main/examples/consumer-api-pagination-example.json
🔗
Examples
https://raw.githubusercontent.com/api-evangelist/thanx/refs/heads/main/examples/consumer-api-purchase-example.json
🔗
Examples
https://raw.githubusercontent.com/api-evangelist/thanx/refs/heads/main/examples/consumer-api-reward-envelope-example.json
🔗
Examples
https://raw.githubusercontent.com/api-evangelist/thanx/refs/heads/main/examples/consumer-api-reward-example.json
🔗
Examples
https://raw.githubusercontent.com/api-evangelist/thanx/refs/heads/main/examples/consumer-api-user-envelope-example.json
🔗
Examples
https://raw.githubusercontent.com/api-evangelist/thanx/refs/heads/main/examples/consumer-api-user-example.json
🔗
Examples
https://raw.githubusercontent.com/api-evangelist/thanx/refs/heads/main/examples/consumer-api-user-input-example.json
🔗
JSONLD
https://raw.githubusercontent.com/api-evangelist/thanx/refs/heads/main/json-ld/thanx-consumer-api-context.jsonld
🔗
Examples
https://raw.githubusercontent.com/api-evangelist/thanx/refs/heads/main/examples/partner-api-campaign-example.json
🔗
Examples
https://raw.githubusercontent.com/api-evangelist/thanx/refs/heads/main/examples/partner-api-campaign-input-example.json
🔗
Examples
https://raw.githubusercontent.com/api-evangelist/thanx/refs/heads/main/examples/partner-api-campaign-variant-input-example.json
🔗
Examples
https://raw.githubusercontent.com/api-evangelist/thanx/refs/heads/main/examples/partner-api-issuance-job-example.json
🔗
Examples
https://raw.githubusercontent.com/api-evangelist/thanx/refs/heads/main/examples/partner-api-partner-user-example.json
🔗
JSONLD
https://raw.githubusercontent.com/api-evangelist/thanx/refs/heads/main/json-ld/thanx-partner-api-context.jsonld
🔗
Regions
https://docs.thanx.com/loyalty/private-link
🔗
Examples
https://raw.githubusercontent.com/api-evangelist/thanx/refs/heads/main/examples/loyalty-api-account-example.json
🔗
Examples
https://raw.githubusercontent.com/api-evangelist/thanx/refs/heads/main/examples/loyalty-api-basket-example.json
🔗
Examples
https://raw.githubusercontent.com/api-evangelist/thanx/refs/heads/main/examples/loyalty-api-basket-input-example.json
🔗
Examples
https://raw.githubusercontent.com/api-evangelist/thanx/refs/heads/main/examples/loyalty-api-basket-item-example.json
🔗
Examples
https://raw.githubusercontent.com/api-evangelist/thanx/refs/heads/main/examples/loyalty-api-loyalty-reward-example.json
🔗
Examples
https://raw.githubusercontent.com/api-evangelist/thanx/refs/heads/main/examples/loyalty-api-payment-example.json
🔗
Examples
https://raw.githubusercontent.com/api-evangelist/thanx/refs/heads/main/examples/loyalty-api-points-product-example.json
🔗
JSONLD
https://raw.githubusercontent.com/api-evangelist/thanx/refs/heads/main/json-ld/thanx-loyalty-api-context.jsonld

Work with this as data

Every API here is available over the APIs.io API and to AI agents over MCP.

MCP server

One button, every client — Claude, Cursor, VS Code and the rest.

https://apis.io/mcp

Tools for apis

7 MCP tools reach this
  • find_apisBrowse and filter every API in the catalog.
  • get_api_artifactsOne API's artifacts, grouped by type.
  • get_openapiThe primary OpenAPI for this API.
  • find_similar_apisAPIs that look like this one.
  • apis_io_searchSTART HERE — APIs, providers and tags for one query, each with its total.
  • resolveTurn a domain, URL or GitHub org into the provider it belongs to.
  • find_cohortsEvery scored population of providers in the catalog.
All 92 tools →

Call it yourself

curl for this page
This API
curl "https://apis.io/api/v1/apis/thanx-metadata-api"
All apis
curl "https://apis.io/api/v1/apis?limit=25"

Discovery needs no key. Ratings and market analysis are Pro.

Get an API key

Free tier, no email required.

A second provider on the same verified email joins the account you already have.

OpenAPI Specification

thanx-metadata-api-openapi.yml Raw ↑
openapi: 3.2.0
info:
  title: Thanx Consumer Account Metadata API
  description: The Thanx Consumer API lets brands integrate Thanx into a custom consumer experience, covering users and authentication, cards, gift cards, rewards, purchases, points and loyalty balances, locations, and feedback. It powers branded apps and digital experiences built on top of the Thanx loyalty and CRM platform. Endpoints are protected and authorized via end-user access tokens acquired through Thanx SSO.
  version: v4.0
  contact:
    name: Kin Lane
    email: kin@apievangelist.com
  license:
    name: Proprietary
servers:
- url: https://api.thanx.com
  description: Production
- url: https://api.thanxsandbox.com
  description: Sandbox
- url: https://secure.api.thanx.com
  description: Production (PCI-scoped card endpoints)
- url: https://secure.api.thanxsandbox.com
  description: Sandbox (PCI-scoped card endpoints)
security:
- bearerAuth: []
  clientId: []
tags:
- name: Metadata
  description: Look up merchants, locations, and scopes.
paths:
  /partner/metadata/merchants:
    get:
      operationId: getMerchants
      summary: Get Merchants
      description: Lists merchants accessible to the partner.
      tags:
      - Metadata
      responses:
        '200':
          description: A list of merchants.
          content:
            application/json:
              schema:
                type: object
                properties:
                  merchants:
                    type: array
                    items:
                      type: object
                      properties:
                        id:
                          type: string
                        name:
                          type: string
              examples:
                GetMerchants200Example:
                  summary: Default getMerchants 200 response
                  x-microcks-default: true
                  value:
                    merchants:
                    - id: 92b7b0dac4
                      name: Pizza Town Co
      x-microcks-operation:
        delay: 0
        dispatcher: FALLBACK
  /partner/metadata/locations:
    get:
      operationId: getPartnerLocations
      summary: Get Locations
      description: Lists locations accessible to the partner.
      tags:
      - Metadata
      parameters:
      - name: merchant_id
        in: query
        schema:
          type: string
        example: 92b7b0dac4
      responses:
        '200':
          description: A list of locations.
          content:
            application/json:
              schema:
                type: object
                properties:
                  locations:
                    type: array
                    items:
                      type: object
                      properties:
                        id:
                          type: string
                        merchant_id:
                          type: string
                        name:
                          type: string
              examples:
                GetPartnerLocations200Example:
                  summary: Default getPartnerLocations 200 response
                  x-microcks-default: true
                  value:
                    locations:
                    - id: 92b7b0dac4
                      merchant_id: 92b7b0dac4
                      name: Pizza Town Co
      x-microcks-operation:
        delay: 0
        dispatcher: FALLBACK
  /partner/metadata/scopes:
    get:
      operationId: getScopes
      summary: Get Scopes
      description: Lists the OAuth scopes available to the partner.
      tags:
      - Metadata
      responses:
        '200':
          description: A list of scopes.
          content:
            application/json:
              schema:
                type: object
                properties:
                  scopes:
                    type: array
                    items:
                      type: string
              examples:
                GetScopes200Example:
                  summary: Default getScopes 200 response
                  x-microcks-default: true
                  value:
                    scopes:
                    - passwordless
      x-microcks-operation:
        delay: 0
        dispatcher: FALLBACK
components:
  securitySchemes:
    bearerAuth:
      type: http
      scheme: bearer
      description: End-user access token acquired through Thanx SSO.
    clientId:
      type: apiKey
      in: header
      name: X-ClientId
      description: Client-specific identifier provided by Thanx.