> ## Documentation Index > Fetch the complete documentation index at: https://docs.sideshift.app/llms.txt > Use this file to discover all available pages before exploring further. # Get pending payouts > Retrieve list of pending payouts for active contracts. Includes detailed payment calculations, pro-rata adjustments, and creator information. Shows payouts that are due, overdue, or upcoming based on contract schedules. ## OpenAPI ````yaml /openapi/platform-apikey.yaml get /payouts/pending openapi: 3.0.4 info: title: Sideshift Public API version: 1.0.0 description: > REST API for Sideshift platform. Authenticate using your API key in the `x-api-key` header. This document covers the **public, API-key-authenticated** surface. The restricted endpoints (Jobs, Applicants, payout execution/Quick Pay) are gated to an explicit partner allowlist and are documented in the **Full Access** spec (`sideshift-api-private.yaml`); a non-allowlisted key calling them receives `403`. API-key *management* (creating/rotating keys, digest automations) is performed in the dashboard with a Firebase session and is not part of this API-key contract. ## Requirements - **Active Subscription Required**: API access requires an active Sideshift subscription. Requests from a company without one return `402 { "error": "Active subscription required" }`. - API key from Settings → Integrations ## Rate Limits - Default: **100 requests per minute** per API key. - Allowlisted partner accounts: **400 requests per minute**. - Every response carries `X-RateLimit-Limit`, `X-RateLimit-Remaining`, and `X-RateLimit-Reset` headers; exceeding the limit returns `429`. ## Errors - Errors are returned as `{ "error": "" }` with the appropriate HTTP status (`400` invalid request, `401` invalid/missing key, `402` no active subscription, `403` restricted endpoint / cross-company, `404` not found, `429` rate limited). Some endpoints add a `code` (e.g. `LEAD_NOT_FOUND`). ## Timestamps - All timestamps are Unix timestamps in milliseconds - Example: `1634567890000` ## Pagination - Most list endpoints support `page` (default: 1) and `limit` (default: 25, max: 100) parameters and return `{ data, page, total }`. Some additionally return `limit` and/or `totalPages`. - Agency (parent) accounts can pass `scope=agency` on analytics/posts endpoints to aggregate across the parent agency and every subaccount. ## Base URL - Production: `https://app.sideshift.app/api/v1` servers: - url: https://app.sideshift.app/api/v1 description: Production server security: - apiKeyAuth: [] tags: - name: Programs description: Campaign and program management - name: Posts description: Social media posts and content - name: Analytics description: Performance metrics and KPIs - name: Payouts description: Payout management including pending payouts and execution - name: Contracts description: Creator contracts and agreements - name: Creators description: Creator profiles and statistics - name: Invoices description: Create, list, and send invoices to customers - name: Discover description: Read Discover leads (brand inquiries) submitted to your agency paths: /payouts/pending: get: tags: - Payouts summary: Get pending payouts description: > Retrieve list of pending payouts for active contracts. Includes detailed payment calculations, pro-rata adjustments, and creator information. Shows payouts that are due, overdue, or upcoming based on contract schedules. parameters: - in: query name: page schema: type: integer default: 1 - in: query name: limit schema: type: integer default: 50 maximum: 100 - in: query name: programId schema: type: string description: Filter by specific program - in: query name: creatorId schema: type: string description: Filter by specific creator - in: query name: minAmount schema: type: number description: Minimum payout amount filter (in dollars) - in: query name: sortBy schema: type: string enum: - amount - dueDate - creator default: amount - in: query name: sortOrder schema: type: string enum: - asc - desc default: desc responses: '200': description: Successfully retrieved pending payouts content: application/json: schema: type: object properties: data: type: array items: type: object properties: id: type: string contractId: type: string contractName: type: string amount: type: number description: Amount in dollars amountCents: type: integer originalAmount: type: number description: Amount before pro-rata originalAmountCents: type: integer currency: type: string status: type: string enum: - overdue - due - upcoming dueDate: type: string format: date-time nullable: true isOverdue: type: boolean isDue: type: boolean programId: type: string nullable: true programName: type: string nullable: true creatorId: type: string creatorName: type: string creatorEmail: type: string nullable: true creatorProfileImageUrl: type: string nullable: true hasStripeAccount: type: boolean deliveredPosts: type: integer requiredPosts: type: integer deliveryPercentage: type: number totalViews: type: integer isProRata: type: boolean paymentComponents: type: array items: type: object paymentStructure: type: object nullable: true page: type: integer limit: type: integer total: type: integer totalPages: type: integer summary: type: object properties: totalPending: type: integer totalAmount: type: number totalAmountCents: type: integer overdueCount: type: integer dueCount: type: integer upcomingCount: type: integer readyToPay: type: integer needsSetup: type: integer components: securitySchemes: apiKeyAuth: type: apiKey in: header name: x-api-key description: API key for authentication. Get yours from Settings → Integrations ````