1. Offers
Target Circle API
  • Shared
    • Schemas
      • Reports
        • Performance
          • PerformanceResultBaseOutput
          • PerformanceResultKpisBaseOutput
          • PerformanceReportMetricsTransactionOutput
          • PerformanceReportMetricsTouchpointOutput
          • PerformanceResultMetricsFinancialOutput
          • PerformanceResultMetricsTrafficOutput
          • PerformanceResultMetricsFraudOutput
          • PerformanceFiltersQueryParams
          • PerformanceSortQueryParams
          • PerformanceDimensionsQueryParams
          • PerformanceMetricsQueryParams
      • Touchpoints
        • TouchpointOutputOld
        • TouchpointStatus
        • TouchpointStatusOutput
        • TouchpointAttributionStatus
        • TouchpointAttributionStatusOutput
        • TouchpointOutputBase
        • TouchpointPricingOutputBase
      • Transactions
        • TransactionOutput
        • TransactionType
        • TransactionTypeOutput
        • TransactionTypeInput
        • TransactionSourceCurrencyOutput
        • TransactionTrackingMethod
        • TransactionTrackingMethodOutput
        • TransactionOrderItem
      • Offers
        • OfferOutput
        • OfferStatus
        • OfferStatusInput
        • OfferStatusOutput
        • OfferVertical
        • OfferVerticalOutput
        • OfferVerticalInput
        • OfferTracking
        • OfferAttributionModel
        • OfferAttributionModelOutput
        • OfferListItem
        • OfferProductGroup
        • OfferProductGroupOutputOverview
        • OfferPriceSegmentOutputOverview
        • OfferDeviceGroupOutputOverview
        • OfferProgram
        • OfferProgramTerms
        • OfferReview
        • OfferFrequentlyAskedQuestion
        • GatewaySection
        • OfferCategory
      • AdInventories
        • OfferOutputOverview
        • OfferInputOverview
        • AdInventoryOutputOverview
        • AdInventoryInputOverview
        • AdInventoryTrafficType
        • AdInventoryTrafficTypeOutput
        • AdInventoryTrafficTypeInput
      • Trades
        • TradeOutput
        • TradeType
        • TradeTypeOutput
        • TradeTypeInput
        • TradeConnectionOutput
        • PriceCombinationOutput
        • TradeOutputList
        • TradeOutputOverview
        • TradePriceCombination
        • TradeAttributionModelException
        • TradePriceCombinationPricingFixed
        • TradePriceCombinationPricingPercentage
        • TradePriceCombinationPricingHybrid
        • TradeBase
        • TradeManual
        • TradeAutomatic
        • TradeScheduled
        • TradeLinksEmbeds
      • Ads
        • AdVoucherCode
        • AdType
        • AdBanner
        • AdTextLink
      • Accounts
        • AdvertiserOutputOverview
        • ProviderOutputOverview
      • Utils
        • PaginationQueryParams
        • DateRange
        • CountryOutput
        • CurrencyInput
        • CurrencyOutput
        • ImageOutput
        • KPITypeMoney
        • KPITypePercentage
        • KPITypeNumber
        • ListMeta
        • MoneyOutput
        • MoneyInput
        • UserOutputOverview
      • Default Folder
        • LanguageOutput
        • SignUpItem
        • Platform
        • SignInItem
  • Publisher API
    • Reports
      • Get Performance Report
    • Touchpoints
      • List touchpoints
      • Retrieve a touchpoint
    • Ads
      • List vouchers
      • List text links
      • List banners
    • Offers
      • List offers
      • Retrieve an offer
      • List offer's FAQs for the Publisher Program
      • List offer's FAQs for the Promoter Program
      • List offer's reviews for the Publisher Program
      • List offer's reviews for the Promoter Program
      • List offer's KPIs for the Publisher Program
      • List offer's KPIs for the Promoter Program
    • Schemas
      • Performance
        • Metrics
          • PerformanceMetricsQueryParams
          • PerformanceResultMetricsFinancialOutput
          • PerformanceReportMetricsTransactionOutput
          • PerformanceReportMetricsTouchpointOutput
          • PerformanceResultMetricsTrafficOutput
          • PerformanceResultMetricsFraudOutput
        • PerformanceResultBaseOutput
        • PerformanceResultOutput
        • PerformanceResultKpisBaseOutput
        • PerformanceResultKpisOutput
        • PerformanceDimensionsQueryParams
        • PerformanceFiltersQueryParams
        • PerformanceSortQueryParams
      • Transactions
        • TransactionTypeOutput
        • TransactionSourceCurrencyOutput
        • TransactionTrackingMethodOutput
        • TransactionType
        • TransactionTrackingMethod
      • Touchpoints
        • TouchpointStatus
        • TouchpointAttributionStatus
        • TouchpointOutput
        • TouchpointOutputBase
        • TouchpointPricingOutputBase
        • TouchpointStatusOutput
        • TouchpointAttributionStatusOutput
        • TouchpointOutputOld
      • Offers
        • OldOfferSchemaForPublishers
        • OfferAttributionModelOutput
        • OfferOutputOverview
        • OfferAttributionModel
        • OfferStatus
        • OfferProductGroupOutputOverview
        • OfferPriceSegmentOutputOverview
      • Default Folder
        • CountryOutput
        • MoneyOutput
        • DateRange
        • PaginationQueryParams
        • ListMeta
      • AdInventories
        • AdInventoryTrafficType
      • Ads
        • AdType
  • Advertiser API
    • Login
      • Get token
      • Login
    • Performance
      • Get Performance Report
    • Transactions
      • Statuses
        • Change transaction status to "Pending"
        • Change transaction status to "Declined"
        • Change transaction status to "Approved"
      • Retrieve a transaction
      • List transactions
    • Touchpoints
      • Statuses
        • Change touchpoint status to "Pending"
        • Change touchpoint status to "Declined"
        • Change touchpoint status to "Approved"
      • List touchpoints
      • Retrieve a touchpoint
    • Offers
      • Product Groups
        • List product groups
        • Create a product group
        • Delete a product group
      • Retrieve an offer
      • Update an offer
      • List offer's KPIs
      • Create an offer
    • Ads
      • Bulk update text links
      • Bulk update banners
    • Trades
      • Retrieve a trade
      • List trades
      • Create a trade
      • Retrieve a price combination
      • List trade's price combinations
      • Create a price combination
      • Bulk update trades
    • Schemas
      • Performance
        • Metrics
          • PerformanceMetricsQueryParams
          • PerformanceResultMetricsFinancialOutput
          • PerformanceReportMetricsTransactionOutput
          • PerformanceReportMetricsTouchpointOutput
          • PerformanceResultMetricsTrafficOutput
          • PerformanceResultMetricsFraudOutput
        • PerformanceResultBaseOutput
        • PerformanceResultOutput
        • PerformanceResultKpisBaseOutput
        • PerformanceResultKpisOutput
        • PerformanceDimensionsQueryParams
        • PerformanceFiltersQueryParams
        • PerformanceSortQueryParams
      • Touchpoints
        • TouchpointSummary
        • TouchpointOutput
        • TouchpointPricingOutput
        • TouchpointOutputBase
        • TouchpointPricingOutputBase
        • TouchpointStatusOutput
        • TouchpointAttributionStatusOutput
        • TouchpointStatus
        • TouchpointAttributionStatus
      • Transactions
        • TransactionTypeOutput
        • TransactionSourceCurrencyOutput
        • TransactionTrackingMethodOutput
        • TransactionType
        • TransactionTrackingMethod
      • Offers
        • OfferOutputOverview
        • OfferAttributionModelOutput
        • OfferProductGroupOutputOverview
        • OfferPriceSegmentOutputOverview
        • OfferAttributionModel
        • OfferStatus
        • OfferCategory
        • OfferDeviceGroupOutputOverview
      • Trades
        • TradeType
        • TradeOutput
        • TradeAttributionModelException
        • TradePriceCombination
        • TradeOutputOverview
        • TradePriceCombinationPricingFixed
        • TradePriceCombinationPricingPercentage
        • TradePriceCombinationPricingHybrid
        • TradeOutputList
      • Ads
        • AdType
      • AdInventories
        • AdInventoryTrafficType
      • Default Folder
        • MoneyOutput
        • CountryOutput
        • DateRange
        • ListMeta
        • PaginationQueryParams
  • Provider API
    • Reports
      • Get Performance Report
    • Transactions
      • Statuses
        • Change transaction status to "Pending"
        • Change transaction status to "Declined"
        • Change transaction status to "Approved"
        • Change transaction status to "Approved, invoiced"
        • Change transaction status to "Approved, paid in"
        • Change transaction status to "Approved, paid out"
        • Change transaction status to "Debt, in collection"
        • Change transaction status to "Debt, uncollectible"
      • List transactions
      • Retrieve a transaction
    • Offers
      • Product Groups
        • List product groups
        • Create a product group
        • Delete a product group
      • Publisher Program
        • List offer's KPIs for the Publisher Program
        • List offer's FAQs for the Publisher Program
        • List offer's Reviews for the Publisher Program
        • Retrieve the publisher program gateway
        • Upload terms attachment of the Publisher Program
        • Delete terms attachment of the Publisher Program
      • Promoter Program
        • List offer's KPIs for the Promoter Program
        • List offer's FAQs for the Promoter Program
        • List offer's Reviews for the Promoter Program
        • Retrieve the promoter program gateway
        • Upload terms attachment of the Promoter Program
        • Delete terms attachment of the Promoter Program
      • List offers
        GET
      • Retrieve an offer
        GET
      • Create an offer
        POST
      • Change offer's status
        PUT
      • Upload offer icon
        PUT
      • Delete offer icon
        DELETE
      • Upload offer logo
        PUT
      • Delete offer logo
        DELETE
    • Touchpoints
      • Statuses
        • Change touchpoint status to "Pending"
        • Change touchpoint status to "Declined"
        • Change touchpoint status to "Approved"
        • Change touchpoint status to "Approved, invoiced"
        • Change touchpoint status to "Approved, paid in"
        • Change touchpoint status to "Approved, paid out"
        • Change touchpoint status to "Debt, in collection"
        • Change touchpoint status to "Debt, uncollectible"
      • List touchpoints
      • Retrieve a touchpoint
    • Ads
      • List banners
      • List text links
    • Trades
      • Retrieve a trade
      • List trades
      • Create a trade
      • Retrieve a price combination
      • List trade's price combinations
      • Create a price combination
    • Finance
      • Invoices
        • Retrieve an invoice
        • Update an invoice
        • List invoices
        • Create an invoice
        • Preview an invoice
        • Update invoice status to "Paid"
        • Update invoice status to "Overdue"
        • Update invoice status to "Debt, In Collection"
        • Update invoice status to "Debt, Uncollectible"
        • Bulk-update invoice statuses to "Overdue"
        • Bulk-update invoice statuses to "Debt, In Collection"
        • Bulk-update invoice statuses to "Debt, Uncollectible"
      • Self Billings
        • Retrieve a self-billing
        • Update a self-billing
        • List self-billings
        • Create a self-billing
        • Preview a self-billing
        • Update self-billing status to "Paid"
        • Bulk-update self-billing statuses to "Paid"
    • Schemas
      • Performance
        • Metrics
          • PerformanceMetricsQueryParams
          • PerformanceResultMetricsFinancialOutput
          • PerformanceReportMetricsTransactionOutput
          • PerformanceReportMetricsTouchpointOutput
          • PerformanceResultMetricsTrafficOutput
          • PerformanceResultMetricsFraudOutput
        • PerformanceResultBaseOutput
        • PerformanceResultOutput
        • PerformanceResultKpisBaseOutput
        • PerformanceResultKpisOutput
        • PerformanceDimensionsQueryParams
        • PerformanceFiltersQueryParams
        • PerformanceSortQueryParams
      • Transactions
        • TransactionTrackingMethod
        • TransactionTypeInput
        • TransactionTypeOutput
        • TransactionSourceCurrencyOutput
        • TransactionTrackingMethodOutput
        • TransactionType
        • TransactionTrackingMethod
      • Touchpoints
        • TouchpointStatus
        • TouchpointAttributionStatus
        • TouchpointOutput
        • TouchpointPricingOutput
        • TouchpointOutputBase
        • TouchpointPricingOutputBase
        • TouchpointStatusOutput
        • TouchpointAttributionStatusOutput
      • Offers
        • OfferStatus
        • OfferOutputOverview
        • OfferInputOverview
        • OfferAttributionModelOutput
        • OfferProductGroupOutputOverview
        • OfferPriceSegmentOutputOverview
        • OfferAttributionModel
      • Ads
        • AdType
      • AdInventories
        • AdInventoryTrafficType
        • AdInventoryInputOverview
      • Trades
        • TradeType
        • Trade
        • TradeListItem
        • TradePriceCombination
        • TradeAttributionModelException
        • TradePriceCombinationPricingFixed
        • TradePriceCombinationPricingPercentage
        • TradePriceCombinationPricingHybrid
        • TradeBase
        • TradeManual
        • TradeAutomatic
        • TradeScheduled
        • TradeLinksEmbeds
      • Finance
        • SelfBillings
          • LineItems
            • SelfBillingLineItemOutput
            • SelfBillingLineItemFeeOutput
            • SelfBillingLineItemExchangeOutput
            • SelfBillingLineItemConvertOutput
            • SelfBillingLineItemBaseInputCreate
            • SelfBillingLineItemExchangeInputCreate
            • SelfBillingLineItemConvertInputCreate
            • SelfBillingLineItemFeeInputCreate
            • SelfBillingLineItemInputCreate
          • SelfBillingBaseOutput
          • SelfBillingStatusOutput
          • SelfBillingListItemOutput
          • SelfBillingStandardOutput
          • SelfBillingCorrectionOutput
          • SelfBillingOutput
          • SelfBillingBaseInputCreate
          • SelfBillingStandardInputCreate
          • SelfBillingCorrectionInputCreate
          • SelfBillingInputCreate
        • Invoices
          • LineItems
            • SelfBillingLineItemBaseOutput
            • InvoiceLineItem
            • InvoiceLineItemBase
            • InvoiceLineItemFee
            • InvoiceLineItemExchange
            • InvoiceLineItemConvert
          • InvoiceInputCreate
          • InvoiceInputPatch
          • InvoiceLineItemInputCreate
          • InvoiceLineItemInputPatch
          • InvoicePayment
          • InvoiceBuyer
          • InvoiceSeller
          • Invoice
          • InvoiceStatus
          • InvoiceListItem
        • Address
        • DocumentPdf
      • Default Folder
        • MoneyOutput
        • MoneyInput
        • UserOutputOverview
        • CountryOutput
        • DateRange
        • PaginationQueryParams
        • ListMeta
  1. Offers

Retrieve an offer

Designing
GET
/api/v3/provider/offers/{sid}
Retrieves the details of an Offer.

Request

Path Params

Responses

🟢200Success
application/json
Bodyapplication/json

🟠401Unauthorized
🟠404Not Found
Request Request Example
Shell
JavaScript
Java
Swift
curl --location '/api/v3/provider/offers/abc123'
Response Response Example
200 - Example 1
{
    "data": {
        "sid": "abc123",
        "status": {
            "code": "underConstruction",
            "name": "string"
        },
        "name": "Little Big Cloud",
        "displayName": "Little Big Cloud",
        "url": "http://example.com",
        "logo": {
            "url": "http://example.com"
        },
        "icon": {
            "url": "http://example.com"
        },
        "attributionModel": {
            "code": "lastClick",
            "name": "string"
        },
        "tracking": {
            "redirecting": {
                "defaultTargetUrl": "http://example.com",
                "defaultTargetUrlParameters": "string",
                "targetUrlFormat": "string"
            },
            "deeplinking": {
                "isEnabled": false
            },
            "autoApproval": {
                "isEnabled": false,
                "daysToApproval": 30
            },
            "customTrackingDomain": {
                "isEnabled": true
            },
            "productLevelTracking": {
                "isEnabled": true
            },
            "conversionPathAttribution": {
                "isEnabled": true
            },
            "cookieExpiration": 2592000,
            "fingerprintExpiration": 2592000,
            "impressionExpiration": 86400
        },
        "startDate": "2019-08-24",
        "endDate": "2019-08-24",
        "vertical": null,
        "category": {
            "code": 0,
            "name": "string"
        },
        "targetedCountries": [
            {
                "code": "DE",
                "name": "Germany"
            }
        ],
        "languages": [
            {
                "code": "EN",
                "name": "English",
                "isDefault": true
            }
        ],
        "provider": {
            "sid": "ghy789",
            "name": "Global Services"
        },
        "advertiser": {
            "sid": "def456",
            "name": "Cloud Corporation"
        },
        "salesManager": {
            "sid": "string",
            "firstName": "string",
            "lastName": "string"
        },
        "appId": "string",
        "programs": {
            "publisher": {
                "code": "publisher",
                "name": "string",
                "status": "enabled",
                "description": "string",
                "terms": {
                    "url": "http://example.com",
                    "content": "string",
                    "attachment": {
                        "url": "http://example.com"
                    }
                },
                "affiliateManager": {
                    "sid": "string",
                    "firstName": "string",
                    "lastName": "string",
                    "email": "string",
                    "avatar": {
                        "url": "http://example.com"
                    }
                },
                "_links": {
                    "x:kpis": {
                        "href": "string"
                    },
                    "x:reviews": {
                        "href": "string"
                    },
                    "x:faqs": {
                        "href": "string"
                    }
                }
            },
            "promoter": {
                "code": "publisher",
                "name": "string",
                "status": "enabled",
                "description": "string",
                "terms": {
                    "url": "http://example.com",
                    "content": "string",
                    "attachment": {
                        "url": "http://example.com"
                    }
                },
                "affiliateManager": {
                    "sid": "string",
                    "firstName": "string",
                    "lastName": "string",
                    "email": "string",
                    "avatar": {
                        "url": "http://example.com"
                    }
                },
                "_links": {
                    "x:kpis": {
                        "href": "string"
                    },
                    "x:reviews": {
                        "href": "string"
                    },
                    "x:faqs": {
                        "href": "string"
                    }
                }
            }
        },
        "_links": {
            "x:productGroups": {
                "href": "string"
            },
            "x:trades": {
                "href": "string"
            },
            "x:adsTextLinks": {
                "href": "string"
            },
            "x:adsBanners": {
                "href": "string"
            }
        },
        "_embedded": {
            "x:adsTextLinks": {
                "data": [
                    {
                        "name": "string",
                        "text": "string",
                        "clickTrackingUrl": "string",
                        "validFrom": "2019-08-24",
                        "validUntil": "2019-08-24",
                        "language": "string",
                        "isDefault": true
                    }
                ],
                "meta": {
                    "total": 144,
                    "limit": 50,
                    "offset": 0
                }
            },
            "x:adsBanners": {
                "data": [
                    {
                        "name": "string",
                        "image": null,
                        "clickTrackingUrl": "string",
                        "impressionTrackingUrl": "string",
                        "validFrom": "2019-08-24",
                        "validUntil": "2019-08-24",
                        "language": "string"
                    }
                ],
                "meta": {
                    "total": 144,
                    "limit": 50,
                    "offset": 0
                }
            }
        }
    }
}
Modified at 2026-09-28 10:59:44
Previous
List offers
Next
Create an offer
Built with