> ## Documentation Index
> Fetch the complete documentation index at: https://docs.repdata.com/llms.txt
> Use this file to discover all available pages before exploring further.

# Export Recipient list recipients

> # Description

Find all recipient list recipients where `recipientListId` is the id to filter recipients. 

# Response
```json
{
  "labels": {},
  "recipients": [
    {
      "email": string,
      "isDeleted": boolean,
      "isUnsubscribed": boolean,
      "unsubscribedAt": string,
      "unsubscribedBy": string,
      "values": object,
      "id": string,
      "recipientListId": string,
      "firstName": string,
      "lastName": string,
      "countryCode": string,
      "phone": string,
      "updatedAt": string,
      "createdAt": string,
      "externalId": number,
    }
  ],
  "totalCount": number,
}
```

where:

- `labels`: Object with labels for every column indexed by column number.  
- `recipients`: Array of recipients with the following data:
  - `email`: Recipient email. *Optional*.  
  - `isDeleted`: Whether or not the recipient is soft deleted or not.  
  - `isUnsubscribed`: Whether or not the recipient is unsubscribed.  
  - `unsubscribedAt`: When the recipient was unsubscribed. *Optional*.
  - `unsubscribedBy`: Hash representing who unsubscribed the recipient. *Optional*.  
  - `values`: Object with recipient values indexed by column number.  
  - `id`: Recipient id.  
  - `recipientListId`: Recipient list id.
  - `firstName`: Recipient first name. *Optional*.
  - `lastName`: Recipient last name. *Optional*.  
  - `countryCode`: Country code for the phone. *Optional*.
  - `phone`: Recipient phone. *Optional*.  
  - `updatedAt`: Last modified date.  
  - `createdAt`: Creation date.  
  - `externalId`: Id assigned by the user.
- `totalCount`: Total recipients returned.

# Description

Find all recipient list recipients where `recipientListId` is the id to filter recipients.

# Response

```json theme={null}
{
  "labels": {},
  "recipients": [
    {
      "email": string,
      "isDeleted": boolean,
      "isUnsubscribed": boolean,
      "unsubscribedAt": string,
      "unsubscribedBy": string,
      "values": object,
      "id": string,
      "recipientListId": string,
      "firstName": string,
      "lastName": string,
      "countryCode": string,
      "phone": string,
      "updatedAt": string,
      "createdAt": string,
      "externalId": number,
    }
  ],
  "totalCount": number,
}
```

where:

* `labels`: Object with labels for every column indexed by column number.
* `recipients`: Array of recipients with the following data:
  * `email`: Recipient email. *Optional*.
  * `isDeleted`: Whether or not the recipient is soft deleted or not.
  * `isUnsubscribed`: Whether or not the recipient is unsubscribed.
  * `unsubscribedAt`: When the recipient was unsubscribed. *Optional*.
  * `unsubscribedBy`: Hash representing who unsubscribed the recipient. *Optional*.
  * `values`: Object with recipient values indexed by column number.
  * `id`: Recipient id.
  * `recipientListId`: Recipient list id.
  * `firstName`: Recipient first name. *Optional*.
  * `lastName`: Recipient last name. *Optional*.
  * `countryCode`: Country code for the phone. *Optional*.
  * `phone`: Recipient phone. *Optional*.
  * `updatedAt`: Last modified date.
  * `createdAt`: Creation date.
  * `externalId`: Id assigned by the user.
* `totalCount`: Total recipients returned.


## OpenAPI

````yaml GET /campaigns-service/v1/recipientLists/{recipientListId}/recipients
openapi: 3.0.3
info:
  title: SightX API
  version: 1.0.0
  description: >-
    SightX REST API documentation. Most responses are JSON; some export
    endpoints return files. API access is a paid add-on — contact
    sales@sightx.io for details.
servers:
  - url: https://auth.admin.sightx.io
    description: Authentication (Production)
  - url: https://auth.staging-admin.sightx.io
    description: Authentication (Staging)
security:
  - AuthorizationHeader: []
paths:
  /campaigns-service/v1/recipientLists/{recipientListId}/recipients:
    get:
      summary: Export Recipient list recipients
      description: >-
        # Description


        Find all recipient list recipients where `recipientListId` is the id to
        filter recipients. 


        # Response

        ```json

        {
          "labels": {},
          "recipients": [
            {
              "email": string,
              "isDeleted": boolean,
              "isUnsubscribed": boolean,
              "unsubscribedAt": string,
              "unsubscribedBy": string,
              "values": object,
              "id": string,
              "recipientListId": string,
              "firstName": string,
              "lastName": string,
              "countryCode": string,
              "phone": string,
              "updatedAt": string,
              "createdAt": string,
              "externalId": number,
            }
          ],
          "totalCount": number,
        }

        ```


        where:


        - `labels`: Object with labels for every column indexed by column
        number.  

        - `recipients`: Array of recipients with the following data:
          - `email`: Recipient email. *Optional*.  
          - `isDeleted`: Whether or not the recipient is soft deleted or not.  
          - `isUnsubscribed`: Whether or not the recipient is unsubscribed.  
          - `unsubscribedAt`: When the recipient was unsubscribed. *Optional*.
          - `unsubscribedBy`: Hash representing who unsubscribed the recipient. *Optional*.  
          - `values`: Object with recipient values indexed by column number.  
          - `id`: Recipient id.  
          - `recipientListId`: Recipient list id.
          - `firstName`: Recipient first name. *Optional*.
          - `lastName`: Recipient last name. *Optional*.  
          - `countryCode`: Country code for the phone. *Optional*.
          - `phone`: Recipient phone. *Optional*.  
          - `updatedAt`: Last modified date.  
          - `createdAt`: Creation date.  
          - `externalId`: Id assigned by the user.
        - `totalCount`: Total recipients returned.
      operationId: >-
        export-recipient-list-recipients-get-campaigns-service-v1-recipientlists-recipientlistid-recipients
      parameters:
        - name: Authorization
          in: header
          required: true
          schema:
            type: string
      responses:
        '200':
          description: Successful response
        '400':
          description: Bad request
        '401':
          description: Unauthorized
        '500':
          description: Internal server error
      servers:
        - url: https://campaigns.sightx.io
components:
  securitySchemes:
    AuthorizationHeader:
      type: apiKey
      in: header
      name: Authorization
      description: Access token obtained from the m2m-token endpoint.

````