> ## Documentation Index > Fetch the complete documentation index at: https://docs.playbackrewards.com/llms.txt > Use this file to discover all available pages before exploring further. # Get active partner offers ## OpenAPI ````yaml /playbackapi/openapi.json get /v1/partners/offers openapi: 3.0.0 info: title: Playback Partner API description: '' version: '1.0' contact: {} servers: - url: https://api.playbackdirect.com security: [] tags: [] paths: /v1/partners/offers: get: tags: - Partners summary: Get active partner offers operationId: PartnerOffersApiController_getOffers parameters: - name: pageSize required: false in: query description: 'Items per page (default: 50, max: 100)' schema: type: number - name: page required: false in: query description: 'Page number (default: 1)' schema: type: number responses: '200': description: Paginated list of offers available to the partner content: application/json: schema: $ref: '#/components/schemas/PaginatedPartnerOffersResponseDto' '400': description: Invalid page or pageSize parameters '401': description: Unauthorized partner security: - bearer: [] components: schemas: PaginatedPartnerOffersResponseDto: type: object properties: offers: description: A list of active partner offers for the page. type: array items: type: object properties: details: description: Metadata and details about the offer. type: object properties: offerId: description: The unique identifier for the specific offer instance. type: string categoryTags: description: A list of category tags associated with the offer. type: array items: type: string description: description: Detailed HTML or text description of the offer. type: string nullable: true trackingLink: description: The tracking link for the offer. type: string supportUrl: description: >- Support form URL with partnerId and offerId pre-filled. Null when not configured. type: string nullable: true startDate: description: The ISO date when this offer becomes available. type: string nullable: true endDate: description: The ISO date when this offer expires. type: string nullable: true duration: description: >- Number of days the user has to complete the offer after activation. type: number nullable: true required: - offerId - categoryTags - description - trackingLink - supportUrl - startDate - endDate - duration app: description: Details about the app or game being promoted. type: object properties: name: description: The full name of the original app or game. type: string description: description: The description of the app or game. type: string packageId: description: >- The OS-specific package ID (e.g., bundle ID on iOS or application ID on Android). type: string platform: description: The platform the offer targets (e.g., "ANDROID" or "IOS"). type: string enum: - ANDROID - IOS storeUrl: description: The URL to the app store page. type: string required: - name - description - packageId - platform - storeUrl payout: description: Financial terms and payout model for the offer. type: object properties: payoutModel: description: >- The cost model for the payout: CPI (Cost Per Install), CPE (Cost Per Event) or CPI_CPE (Hybrid CPI+CPE). type: string enum: - CPI - CPE - CPI_CPE x-enumNames: - CPI - CPE - CPI_CPE totalPayout: description: >- The total potential payout the partner can receive from this offer, in USD. type: number currency: description: The fiat currency in which payouts are calculated. type: string enum: - USD required: - payoutModel - totalPayout - currency targeting: description: Targeting rules and limitations for the offer. type: object properties: platform: description: The platform the offer is restricted to. type: string enum: - ANDROID - IOS countries: description: >- List of allowed countries, as ISO 3166-1 alpha-2 country codes, for this offer. type: array items: type: string required: - platform - countries caps: description: Limitations for the offer. type: object properties: hourlyInstallCap: description: Maximum allowed installs globally per hour. type: number nullable: true dailyInstallCap: description: Maximum allowed installs globally per day. type: number nullable: true required: - hourlyInstallCap - dailyInstallCap tasks: description: A list of distinct measurable events or milestones. type: array items: oneOf: - type: object properties: id: description: Unique identifier for the task. type: string type: description: The type of task. type: string enum: - EVENT - PURCHASE - INSTALL description: description: Human-readable description of the required action. type: string dependsOn: description: >- List of task IDs that must be completed before this task becomes available. type: array items: type: string delay: description: >- The time in minutes after offer activation before this task becomes available. type: integer nullable: true duration: description: >- The time window in minutes for completing this task after it becomes available - starting after the offer is activated by the user plus any delay specified for this task. type: integer nullable: true payout: description: >- The payout awarded to the partner upon completion of this task, in USD. type: number userPayout: description: >- The payout amount suggested to reward the user, in USD. type: number evr: description: >- Event Value Rate: the expected percentage (0-1) of activating users that complete this task. Null when no rate is available. type: number nullable: true required: - id - type - description - delay - duration - payout - userPayout - evr creativeAssets: description: A list of visual assets to promote the app. type: array items: type: object properties: type: description: The type of creative asset. type: string enum: - ICON url: description: The secure URL where the asset is hosted. type: string required: - type - url kpis: description: Performance KPIs the advertiser will evaluate for this offer. type: array items: type: object properties: type: description: >- Whether this KPI is hard (blocks payout if missed) or soft (informational). type: string enum: - hard - soft metric: description: The KPI metric being measured. type: string enum: - retention - roi - roas - event eventName: description: The specific event name when metric is "event". type: string thresholds: description: Ordered list of thresholds to evaluate for this KPI. type: array items: type: object properties: day: description: >- Day number after activation when this threshold is evaluated. type: number operator: description: Comparison operator for the threshold. type: string enum: - gt - lt - gte - lte - eq value: description: Target value for the threshold. type: number unit: description: Unit of the threshold value. type: string enum: - percentage - currency - count required: - day - operator - value - unit required: - type - metric - thresholds required: - details - app - payout - targeting - caps - tasks - creativeAssets pagination: description: Pagination information. type: object properties: page: description: The current page number. type: number pageSize: description: The number of items shown per page. type: number totalCount: description: The total number of available offers. type: number totalPages: description: The total number of available pages. type: number required: - page - pageSize - totalCount - totalPages required: - offers - pagination securitySchemes: bearer: scheme: bearer bearerFormat: Partner Token type: http ````