> ## Documentation Index > Fetch the complete documentation index at: https://onlytraffic.com/docs/llms.txt > Use this file to discover all available pages before exploring further. # Пулы > Your cross-promo pools. ## OpenAPI ````yaml GET /shoutouts/pools openapi: 3.0.3 info: title: OnlyTraffic Studio API version: 1.1.0 description: >- External API for OnlyTraffic Studio. Manage and retrieve data about your subscribers, CPL campaigns, CPC orders and CPC campaigns. servers: - url: https://studio-api.onlytraffic.com/api/external/v1 security: - ApiKeyAuth: [] tags: - name: Account description: API key holder's wallet, profile, and aggregate state. - name: Accounts description: OnlyFans accounts attached to the API key holder. - name: Agencies description: Agency CRUD and image management. All edits stage in moderation. - name: CPL description: >- Cost-per-lead orders: place, list, cancel, manage settings, browse partner offers. - name: CPC description: Cost-per-click orders and creative management. - name: RevShare description: Revenue-share campaigns and invoices. - name: Swaps description: Two-sided traffic swap orders and offers. - name: Subscribers description: Per-fan delivery feed (cursor-paginated). - name: Transactions description: Per-transaction OF revenue feed (cursor-paginated). - name: Shoutouts description: Cross-promo pools, creatives and the publication log. paths: /shoutouts/pools: get: tags: - Shoutouts summary: Pools description: Your cross-promo pools. operationId: getShoutoutPools parameters: - $ref: '#/components/parameters/Page' - $ref: '#/components/parameters/PageSize' - name: status in: query schema: type: string enum: - active - paused - completed - archived description: Filter by pool status. - $ref: '#/components/parameters/SinceChangedAt' - $ref: '#/components/parameters/UntilChangedAt' - name: sort in: query schema: type: string enum: - created_at_desc - created_at_asc - updated_at_desc - start_date_desc - start_date_asc default: created_at_desc description: Sort order. responses: '200': description: Successful response content: application/json: schema: type: object properties: success: type: boolean example: true data: type: array items: $ref: '#/components/schemas/ShoutoutPool' pagination: $ref: '#/components/schemas/Pagination' '401': description: Missing or invalid API key content: application/json: schema: $ref: '#/components/schemas/ErrorResponse' '429': description: Rate limit exceeded content: application/json: schema: $ref: '#/components/schemas/ErrorResponse' '500': description: >- Server error. Body always reads `{success:false, error:"server_error", message:"Server error"}` (no internal details leak). content: application/json: schema: $ref: '#/components/schemas/ErrorResponse' components: parameters: Page: name: page in: query schema: type: integer minimum: 1 default: 1 description: Page number, 1-indexed. example: 1 PageSize: name: page_size in: query schema: type: integer minimum: 1 maximum: 100 default: 50 description: Items per page. Default 50, max 100. example: 50 SinceChangedAt: name: since_changed_at in: query schema: type: integer minimum: 0 description: >- Delta-sync filter. Return only rows whose `changed_at` is at or after this UNIX timestamp. Pair with `until_changed_at` for a window. example: 1738000000 UntilChangedAt: name: until_changed_at in: query schema: type: integer minimum: 0 description: >- Delta-sync filter. Return only rows whose `changed_at` is strictly before this UNIX timestamp. Useful to lock the upper bound while paginating an open delta range. example: 1738604800 schemas: ShoutoutPool: type: object properties: pool_id: type: string format: uuid example: 550e8400-e29b-41d4-a716-446655440000 name: type: string example: Summer promo status: type: string enum: - active - paused - completed - archived formats: type: array items: type: string enum: - story - post - bio - friends - mass_dm start_date: type: string format: date end_date: type: string format: date nullable: true description: Empty = runs until paused. rotation_type: type: string enum: - equal - priority - weighted daily_limits: type: object description: >- Per publisher per day for `story`, `post` (posts held at once) and `mass_dm`. additionalProperties: type: integer example: story: 2 mass_dm: 1 same_target_cooldown_days: type: integer description: >- Days before the same publisher promotes the same model again in the same format. friends_ttl_days: type: integer bio_ttl_days: type: integer post_ttl_days: type: integer publish_settings: $ref: '#/components/schemas/ShoutoutPublishSettings' hosts: type: array items: $ref: '#/components/schemas/ShoutoutPoolHost' targets: type: array items: $ref: '#/components/schemas/ShoutoutPoolTarget' published: type: object description: Placements that went out, per format. additionalProperties: type: integer created_at: type: string format: date-time created_at_ts: type: integer updated_at: type: string format: date-time nullable: true updated_at_ts: type: integer nullable: true Pagination: type: object description: >- Page-based pagination, returned by every list endpoint that isn't a cursor feed. properties: page: type: integer description: Current page number (1-indexed). example: 1 page_size: type: integer description: Number of items per page. Default 50, max 100. example: 50 total: type: integer description: Total number of records matching the filters. example: 150 total_pages: type: integer description: Total pages available. example: 3 has_next: type: boolean description: >- `true` when `page < total_pages` (i.e. there is at least one more page to fetch). example: true ErrorResponse: type: object description: Standard error envelope for all 4xx/5xx responses. required: - success - error - message properties: success: type: boolean enum: - false description: Always false on error responses. error: type: string description: Stable snake_case machine-readable error code. Branch on this. example: validation_failed message: type: string description: >- Human-friendly text. For 5xx this is always the literal `Server error`. For 4xx an actionable validation/auth message is returned. details: type: object nullable: true description: >- Optional per-field diagnostic information. On 422 carries `{: ["error_code", ...]}`. On 402 (`insufficient_balance`) carries `{required, current}`. On 426 (`unpaid_invoices`) carries `{count, total, oldest_date_ts}`. Absent on most other errors. additionalProperties: true retry_after: type: integer nullable: true description: >- Seconds until the next request will succeed. Present only on 429 responses (rate limit). Mirrors the `Retry-After` HTTP header. ShoutoutPublishSettings: type: object description: How publications go out. properties: pin_posts: type: boolean description: Pin promo posts on top of the publisher's profile. post_media_mode: type: string enum: - carousel - random description: >- All photos of the creative in one post, or one random photo per post. vault_cleanup: type: boolean description: Hide the published media from the publisher's vault afterwards. vault_folder: type: boolean description: >- File the published media into the OT Shoutouts vault folder (ignored while `vault_cleanup` is on). mass_dm: $ref: '#/components/schemas/ShoutoutMassDmSettings' ShoutoutPoolHost: type: object properties: of_account_id: type: integer username: type: string nullable: true session_status: type: string enum: - active - error - not_available ShoutoutPoolTarget: type: object properties: of_account_id: type: integer username: type: string nullable: true weight: type: integer minimum: 1 maximum: 5 description: Share of mentions under weighted rotation. creatives: type: object properties: story: type: integer post: type: integer bio: type: integer mass_dm: type: integer ShoutoutMassDmSettings: type: object description: Mass message audience and behaviour. properties: send_to: type: array items: type: string maxLength: 50 maxItems: 20 description: >- OnlyFans list names the message goes to, matched by name on every publisher (the built-in `Fans`, `Following` or your own lists). Required while the `mass_dm` format is on. example: - Fans exclude_lists: type: array items: type: string maxLength: 50 maxItems: 20 description: >- List names removed from the audience; `*` stands for any characters (`Alt*`). example: - Alt* unsend_previous: type: boolean description: >- Unsend the earlier promo mailing that reached the same fans before a new one goes out. default: true securitySchemes: ApiKeyAuth: type: apiKey in: header name: X-API-Key description: Your API key from the Studio Dashboard ````