> ## Documentation Index > Fetch the complete documentation index at: https://docs.polymorfa.com/llms.txt > Use this file to discover all available pages before exploring further. # List campaign recipients > Lists a campaign's recipients in queue order with cursor pagination. Filter by `status`; a recipient skipped because the number opted out has `status` `skipped` and `lastError` `opted_out`. Requires `campaigns:read`. Project tokens only access resources in their own project. ## OpenAPI ````yaml api-reference/features/campaigns.json GET /platform/campaigns/{campaignId}/recipients openapi: 3.0.3 info: title: Campaigns API methods version: 1.0.0 description: Task-focused campaigns methods across supported Polymorfa connection types. servers: [] security: [] paths: /platform/campaigns/{campaignId}/recipients: get: tags: - Campaigns summary: List campaign recipients description: >- Lists a campaign's recipients in queue order with cursor pagination. Filter by `status`; a recipient skipped because the number opted out has `status` `skipped` and `lastError` `opted_out`. Requires `campaigns:read`. Project tokens only access resources in their own project. operationId: managementListCampaignRecipients parameters: - name: campaignId in: path required: true schema: type: string description: Identifier for the campaign. - name: projectId in: query required: false description: >- Project the campaign belongs to. Required with a team API key; a project token is bound to its own project and omits it. **Value constraints** | Constraint | Accepted input | | --- | --- | | Format | `uuid` | schema: type: string format: uuid description: >- Project that owns the campaign. Required for team API keys; a project token is bound to its own project. - schema: type: string enum: - queued - sending - sent - delivered - read - failed - skipped required: false name: status in: query description: |- Current status of this resource or operation. **Allowed values** | Value | Meaning | | --- | --- | | `queued` | Queued. | | `sending` | Sending. | | `sent` | Sent. | | `delivered` | Delivered. | | `read` | Read. | | `failed` | Failed. | | `skipped` | Skipped. | - name: cursor in: query required: false schema: type: string minLength: 1 maxLength: 256 description: |- Specifies cursor for this query parameter. **Value constraints** | Constraint | Accepted input | | --- | --- | | String length | `1` through `256` characters | - name: limit in: query required: false schema: type: integer minimum: 1 maximum: 100 default: 25 description: |- Specifies limit for this query parameter. **Value constraints** | Constraint | Accepted input | | --- | --- | | Numeric value | `1` through `100` (inclusive) | responses: '200': description: Success headers: X-Request-Id: schema: type: string description: Stable request correlation identifier. Polymorfa-Version: schema: type: string description: API version applied to this response. content: application/json: schema: type: object additionalProperties: false properties: data: type: array items: $ref: '#/components/schemas/management__CampaignRecipient' description: Structured data carried by this object. page: allOf: - $ref: '#/components/schemas/management__CursorPageMetadata' description: Specifies page for this schema. required: - data - page '400': $ref: '#/components/responses/management__BadRequest' '401': $ref: '#/components/responses/management__Unauthorized' '403': $ref: '#/components/responses/management__Forbidden' '404': $ref: '#/components/responses/management__NotFound' security: - management__ApiKeyAuth: [] servers: - url: https://api.polymorfa.com components: schemas: management__CampaignRecipient: type: object additionalProperties: false properties: id: type: string format: uuid description: |- Identifier for this resource. **Value constraints** | Constraint | Accepted input | | --- | --- | | Format | `uuid` | phone: type: string description: Phone number in international format. variables: type: object additionalProperties: true description: Structured variables values for this management campaign recipient. variantKey: type: string nullable: true description: |- Specifies variant key for this management campaign recipient. **Accepted alternatives** | Alternative | Accepted input | | --- | --- | | Alternative 1 | Type: `string` | | Alternative 2 | `null` | status: type: string enum: - queued - sending - sent - delivered - read - failed - skipped description: |- Current status of this resource or operation. **Allowed values** | Value | Meaning | | --- | --- | | `queued` | Queued. | | `sending` | Sending. | | `sent` | Sent. | | `delivered` | Delivered. | | `read` | Read. | | `failed` | Failed. | | `skipped` | Skipped. | attempts: type: integer minimum: 0 description: |- Specifies attempts for this management campaign recipient. **Value constraints** | Constraint | Accepted input | | --- | --- | | Numeric value | `0` or greater | lastError: type: string nullable: true description: >- Why the recipient failed or was skipped. `opted_out` means the number is on the team's opt-out list. **Accepted alternatives** | Alternative | Accepted input | | --- | --- | | Alternative 1 | Type: `string` | | Alternative 2 | `null` | externalMessageId: type: string nullable: true description: |- Identifier for the external message. **Accepted alternatives** | Alternative | Accepted input | | --- | --- | | Alternative 1 | Type: `string` | | Alternative 2 | `null` | queuedAt: type: integer description: Timestamp for queued at. sentAt: type: integer nullable: true description: |- Timestamp for sent at. **Accepted alternatives** | Alternative | Accepted input | | --- | --- | | Alternative 1 | Type: `integer` | | Alternative 2 | `null` | deliveredAt: type: integer nullable: true description: |- Timestamp for delivered at. **Accepted alternatives** | Alternative | Accepted input | | --- | --- | | Alternative 1 | Type: `integer` | | Alternative 2 | `null` | readAt: type: integer nullable: true description: |- Timestamp for read at. **Accepted alternatives** | Alternative | Accepted input | | --- | --- | | Alternative 1 | Type: `integer` | | Alternative 2 | `null` | failedAt: type: integer nullable: true description: |- Timestamp for failed at. **Accepted alternatives** | Alternative | Accepted input | | --- | --- | | Alternative 1 | Type: `integer` | | Alternative 2 | `null` | respondedAt: type: integer nullable: true description: |- Timestamp for responded at. **Accepted alternatives** | Alternative | Accepted input | | --- | --- | | Alternative 1 | Type: `integer` | | Alternative 2 | `null` | required: - id - phone - variables - variantKey - status - attempts - lastError - externalMessageId - queuedAt - sentAt - deliveredAt - readAt - failedAt - respondedAt management__CursorPageMetadata: type: object additionalProperties: false properties: nextCursor: type: string nullable: true description: |- Specifies next cursor for this management cursor page metadata. **Accepted alternatives** | Alternative | Accepted input | | --- | --- | | Alternative 1 | Type: `string` | | Alternative 2 | `null` | hasMore: type: boolean description: Whether more. required: - nextCursor - hasMore management__ErrorEnvelope: type: object required: - error - data - docs properties: error: type: object required: - type - code - message - param - request_id properties: type: type: string enum: - invalid_request_error - authentication_error - permission_error - conflict_error - rate_limit_error - api_error - upstream_error description: |- Type discriminator for this object. **Allowed values** | Value | Meaning | | --- | --- | | `invalid_request_error` | Invalid request error. | | `authentication_error` | Authentication error. | | `permission_error` | Permission error. | | `conflict_error` | Conflict error. | | `rate_limit_error` | Rate limit error. | | `api_error` | Api error. | | `upstream_error` | Upstream error. | code: type: string description: Stable failure code. Use this value for programmatic handling. message: type: string description: Safe explanation of the failure. param: type: string nullable: true description: |- Invalid request field, or null when no field applies. **Accepted alternatives** | Alternative | Accepted input | | --- | --- | | Alternative 1 | Type: `string` | | Alternative 2 | `null` | request_id: type: string description: >- Matches the X-Request-Id response header. Include it when you contact support. request_log_url: type: string format: uri description: >- Console page that shows this request. Returned only to organization and project credentials whose request was logged. **Value constraints** | Constraint | Accepted input | | --- | --- | | Format | `uri` | description: Error details returned when the operation fails. data: type: string nullable: true enum: - null description: |- Always null for a failed request. **Allowed values** | Value | Meaning | | --- | --- | | `null` | Null. | **Accepted alternatives** | Alternative | Accepted input | | --- | --- | | Alternative 1 | Type: `string` | | Alternative 2 | `null` | docs: type: string format: uri description: |- Documentation link to this failure code. **Value constraints** | Constraint | Accepted input | | --- | --- | | Format | `uri` | responses: management__BadRequest: description: A path, query, or request-body value did not pass validation. headers: X-Request-Id: schema: type: string description: Stable request correlation identifier. Polymorfa-Version: schema: type: string description: API version applied to this response. content: application/json: schema: $ref: '#/components/schemas/management__ErrorEnvelope' management__Unauthorized: description: Missing/invalid credential for this audience. headers: X-Request-Id: schema: type: string description: Stable request correlation identifier. Polymorfa-Version: schema: type: string description: API version applied to this response. content: application/json: schema: $ref: '#/components/schemas/management__ErrorEnvelope' management__Forbidden: description: Authenticated but lacks the required scope/role/audience. headers: X-Request-Id: schema: type: string description: Stable request correlation identifier. Polymorfa-Version: schema: type: string description: API version applied to this response. content: application/json: schema: $ref: '#/components/schemas/management__ErrorEnvelope' management__NotFound: description: >- The requested resource was not found inside the authenticated team or project scope. headers: X-Request-Id: schema: type: string description: Stable request correlation identifier. Polymorfa-Version: schema: type: string description: API version applied to this response. content: application/json: schema: $ref: '#/components/schemas/management__ErrorEnvelope' securitySchemes: management__ApiKeyAuth: type: http scheme: bearer description: >- Send your team API key or project token as `Authorization: Bearer `. The credential must have the required permissions. Project tokens can access only their own project. ```` This documentation is built and hosted on [Mintlify](https://mintlify.com), a developer documentation platform.