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/imprint:imprint-offers-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 form to fill in. Signing in shares your email address with us — we store it to create your key and to recognise you if you sign in with another provider. See our Privacy Policy and Terms.

GitHub Google LinkedIn

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

OpenAPI Specification

openapi: 3.2.0
info:
  title: Public Imprint Offers API
  version: '2.0'
servers:
- url: https://dev.sbx.imprint.co
  description: Imprint public api sandbox
security:
- basicAuth: []
- bearerAuth: []
tags:
- name: Offers
paths:
  /v2/offers:
    get:
      tags:
      - Offers
      summary: Retrieve an offer
      x-excluded: true
      operationId: getOffer
      description: Returns the marketing placement for the given customer
      parameters:
      - name: partner_customer_id
        in: query
        description: The unique identifier for the customer in the partner's system
        schema:
          $ref: '#/components/schemas/PartnerCustomerId'
      responses:
        '200':
          description: Successfully returned marketing placement
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Offer'
        '404':
          description: Customer not found
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/PartnerCustomerNotFoundError'
components:
  schemas:
    Offer:
      type: object
      description: Offer marketing placement returned for a partner customer
      required:
      - id
      - is_prescreened
      - title
      - description
      properties:
        id:
          type: string
          description: The unique ID Imprint assigns to the offer placement
          example: 2ade1a36-b6f7-489b-a941-865c33f82f5a
        is_prescreened:
          type: boolean
          description: Indicates whether the offer is a prescreened offer
          example: true
        title:
          type: string
          description: Short, human-readable title for the offer
          example: 'Welcome Offer: Earn $25'
        description:
          type: string
          description: Full marketing copy for the offer
          example: Sign-up, accept your offer, and spend $500 in the first 90 days of becoming a member to unlock your $25 welcome bonus. To qualify for the $25 bonus, you must make qualifying purchases totaling $500 or more using your Company® Card within 90 days of account approval.
    PartnerCustomerId:
      type: string
      minLength: 1
      maxLength: 128
      pattern: ^[\x20-\x7E]+$
      description: 'The unique identifier for the customer in the partner''s system.


        Compared byte-for-byte, so `PARTNER_USER_456` and `partner_user_456` are

        two different customers. Send the same casing everywhere or a later

        lookup silently returns no match.


        Restricted to printable ASCII (`\x20`–`\x7E`) rather than arbitrary

        UTF-8: the value is propagated between internal services as an HTTP/2

        header, which cannot carry non-ASCII bytes. The bound is published

        rather than discovered.

        '
      example: PARTNER_USER_456
    PartnerCustomerNotFoundError:
      type: object
      required:
      - type
      - message
      properties:
        type:
          type: string
          description: The category of error being returned
          example: PARTNER_CUSTOMER_NOT_FOUND_ERROR
        message:
          type: string
          description: A message describing the cause of the error
          example: 'Partner Customer not found for provided ID: abcd-efgh-123'
        param:
          type: string
          description: The param causing the error
          example: partner_customer_id
  securitySchemes:
    basicAuth:
      type: http
      scheme: basic
      description: 'Basic HTTP authentication. Allowed headers-- Authorization: Basic <base64(api_key_id:api_key_secret)>'
    bearerAuth:
      bearerFormat: auth-scheme
      description: 'Bearer HTTP authentication. Allowed headers-- Authorization: Bearer <api_key>'
      scheme: bearer
      type: http
x-provenance:
  method: harvested
  publisher: Imprint
  source: https://docs.imprint.co/api-reference/openapi.yaml
  note: split by refine-openapis from the provider's own published document, verified by fetch (openapi/_original/*.fetch.json);
    stamped by stamp-openapi-provenance.py (roadmap#793)