1. Using the API
Target Circle API
  • Publisher API
    • Ads
      • List vouchers
    • Offers
      • List offers
    • Schemas
      • Transaction
        • TransactionType
      • Offer
        • OfferStatus
        • OfferReview
        • OfferFrequentlyAskedQuestion
        • OfferCategory
        • OfferVertical
        • OfferTracking
        • OfferTargetedCountry
        • OfferKpi
        • OfferPriceSegment
        • OfferDeviceGroup
        • Offer
        • OfferProductGroup
        • OfferAttributionModel
      • Voucher
      • TextLink
      • Banner
      • Link
      • Connection
      • PriceCombination
      • Image
      • Currency
      • Advertiser
      • Provider
      • Money
      • Error
      • KPI
  • Advertiser API
    • Using the API
      • Authorization
    • Login
      • Get token
      • Login
    • Performance
    • Transactions
      • Set transaction status to "pending"
      • Set transaction status to "declined"
      • Set transaction status to "approved"
    • Touchpoints
    • Offers
    • Ads
      • Bulk update text links
      • Bulk update banners
    • Trades
      • Bulk update trades
    • Schemas
      • Offer
        • OfferPriceSegment
        • OfferProductGroup
        • OfferStatus
        • OfferTracking
        • OfferTargetedCountry
        • OfferOverview
        • OfferCategory
        • OfferVertical
        • AttributionModel Filter
        • OfferStatus Filter
        • Offer
        • OfferAttributionModel
        • OfferFrequentlyAskedQuestion
        • OfferReview
      • Transaction
        • TransactionType
        • TransactionSourceCurrency
        • TransactionTrackingMethod
        • TransactionType Filter
        • TransactionOrderItem
      • Touchpoint
        • TouchpointStatus
        • TouchpointSummary
        • AttributionStatus Filter
        • TouchpointAttributionStatus
      • Job
      • Currency
      • Provider
      • Advertiser
      • Money
      • TradeType
      • TradeType Filter
      • AdType
      • AdType Filter
      • AdInventoryTrafficType
      • PriceCombination
      • KPI
      • Image
  • Provider API
    • Using the API
      • Naming Conventions
      • Authorization
      • Linking & Embedding
    • Offers
      • List offers
      • Create an offer
    • Trades
      • List trades
    • Schemas
      • Transaction
        • TransactionType
      • Offer
        • OfferVertical
        • OfferTargetedCountry
        • OfferPriceSegment
        • OfferDeviceGroup
        • Offer
        • OfferProgram
        • OfferCategory
        • GatewaySection
        • OfferProductGroup
        • OfferTracking
        • OfferStatus
        • OfferReview
        • OfferFrequentlyAskedQuestion
        • OfferAttributionModel
        • OfferProgramTerms
      • SignUpItem
      • Language
      • Connection
      • PriceCombination
      • SignInItem
      • Image
      • Currency
      • Platform
      • Advertiser
      • Provider
      • Money
      • AdInventoryTrafficType
      • Trade
      • TradeType
      • KPI
  1. Using the API

Naming Conventions

Resource Names#

To keep our architecture clean and predictable, all resource names strictly adhere to the following rules:
Noun-Based & Plural: Always use plural nouns (e.g., customers), never verbs (e.g., get-user).
Lowercase Only: All characters must be lowercase.
Kebab-Case (Letters & Hyphens): Use only alphabetic characters and hyphens (-) to separate words. No numbers, underscores, or special characters allowed.

Query Parameter Names#

To keep our architecture clean and predictable, all query parameter names strictly adhere to the following rules:
camelCase: Use standard camelCase for multi-word parameter names. The first letter must be lowercase, and each subsequent word starts with a capital letter.
Modified at 2026-07-17 13:45:36
Previous
Image
Next
Authorization
Built with