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

# List subscribers

> Returns a paginated list of active subscribers in the environment



## OpenAPI

````yaml /openapi.json get /subscribers
openapi: 3.1.0
info:
  title: subscriber.dev API
  description: >-
    Trigger workflows, manage subscribers and send broadcasts. Authenticate with
    an API key in the X-API-Key header: the key decides the environment. Docs:
    https://docs.subscriber.dev
  version: '1.0'
  contact: {}
servers:
  - url: https://api.subscriber.dev
    description: Cloud
security: []
tags: []
paths:
  /subscribers:
    get:
      tags:
        - Subscribers
      summary: List subscribers
      description: Returns a paginated list of active subscribers in the environment
      operationId: listSubscribers
      parameters:
        - name: limit
          required: false
          in: query
          schema:
            minimum: 1
            maximum: 100
            default: 20
            type: number
        - name: offset
          required: false
          in: query
          schema:
            minimum: 0
            maximum: 9007199254740991
            default: 0
            type: number
        - name: email
          required: false
          in: query
          description: Filter to the subscriber with this exact email address
          schema:
            type: string
            format: email
            pattern: >-
              ^(?:[A-Za-z0-9_'+\-]+\.)*[A-Za-z0-9_'+\-]*[A-Za-z0-9_+-]@(?:[A-Za-z0-9][A-Za-z0-9\-]*\.)+[A-Za-z]{2,}$
        - name: externalId
          required: false
          in: query
          description: Filter to the subscriber with this exact external ID
          schema:
            type: string
        - name: q
          required: false
          in: query
          description: >-
            Case-insensitive partial match across email, phone, externalId,
            firstName, lastName, and name
          schema:
            type: string
            minLength: 1
        - name: emailOptedIn
          required: false
          in: query
          description: >-
            Filter by the subscriber's latest email preference (true = opted in,
            false = opted out)
          schema:
            type: boolean
            enum:
              - 'true'
              - 'false'
      responses:
        '200':
          description: ''
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ListSubscribersResponse'
        '401':
          description: Missing or invalid API key
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorResponse'
        '404':
          description: Environment not found
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorResponse'
        '429':
          description: Rate limited. Wait a second and retry.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorResponse'
      security:
        - bearer: []
        - api-key:
            - subscribers:read
components:
  schemas:
    ListSubscribersResponse:
      type: object
      properties:
        subscribers:
          type: array
          items:
            type: object
            properties:
              publicId:
                type: string
              email:
                type:
                  - string
                  - 'null'
              phone:
                type:
                  - string
                  - 'null'
              externalId:
                type:
                  - string
                  - 'null'
              firstName:
                type:
                  - string
                  - 'null'
              lastName:
                type:
                  - string
                  - 'null'
              name:
                type:
                  - string
                  - 'null'
              attributes:
                anyOf:
                  - type: object
                    propertyNames:
                      type: string
                    additionalProperties: {}
                  - type: 'null'
              createdVia:
                description: >-
                  How the subscriber was created: "api", "mcp", or an inbound
                  source such as "stripe".
                type:
                  - string
                  - 'null'
              createdAt:
                type: string
                format: date-time
                pattern: >-
                  ^(?:(?:\d\d[2468][048]|\d\d[13579][26]|\d\d0[48]|[02468][048]00|[13579][26]00)-02-29|\d{4}-(?:(?:0[13578]|1[02])-(?:0[1-9]|[12]\d|3[01])|(?:0[469]|11)-(?:0[1-9]|[12]\d|30)|(?:02)-(?:0[1-9]|1\d|2[0-8])))T(?:(?:[01]\d|2[0-3]):[0-5]\d:[0-5]\d(?:\.\d+)?(?:Z))$
              updatedAt:
                type: string
                format: date-time
                pattern: >-
                  ^(?:(?:\d\d[2468][048]|\d\d[13579][26]|\d\d0[48]|[02468][048]00|[13579][26]00)-02-29|\d{4}-(?:(?:0[13578]|1[02])-(?:0[1-9]|[12]\d|3[01])|(?:0[469]|11)-(?:0[1-9]|[12]\d|30)|(?:02)-(?:0[1-9]|1\d|2[0-8])))T(?:(?:[01]\d|2[0-3]):[0-5]\d:[0-5]\d(?:\.\d+)?(?:Z))$
            required:
              - publicId
              - email
              - phone
              - externalId
              - firstName
              - lastName
              - name
              - attributes
              - createdVia
              - createdAt
              - updatedAt
        limit:
          type: number
        offset:
          type: number
      required:
        - subscribers
        - limit
        - offset
    ErrorResponse:
      type: object
      properties:
        statusCode:
          type: integer
          example: 404
        message:
          type: string
          example: Workflow not found
        error:
          type: string
          example: Not Found
        errors:
          description: Which fields failed validation, on a 400.
          type: array
          items:
            type: object
            properties:
              path:
                type: array
                items:
                  anyOf:
                    - type: string
                    - type: number
              message:
                type: string
              code:
                type: string
            required:
              - path
              - message
      required:
        - statusCode
        - message
  securitySchemes:
    bearer:
      scheme: bearer
      type: http
      description: >-
        A session token from `subscriber login`, used by subscriber.dev's own
        apps. Requests about an environment also need its ID in the
        `x-environment-id` header. From your own code, use an API key.
    api-key:
      type: apiKey
      in: header
      name: X-API-Key
      description: An environment API key. Keep it on your server.

````

This documentation is built and hosted on [Mintlify](https://mintlify.com), a developer documentation platform.