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

# List subscribers

> Return json data about subscribers



## OpenAPI

````yaml openapi2 GET /subscribers
openapi: 3.0.3
info:
  title: Paubox Marketing API
  description: >
    Public documentation Paubox Marketing API. 


    All Paubox Marketing customers have access to the Paubox Marketing API to
    automate various tasks.


    ## Authentication

    Use the authorization header in requests with the format: `authorization:
    Token token=<API_KEY>`


    Replace `<API_KEY>` with your API key. Find your API key in the address bar
    from the email builder (note: each API Key is displayed only once upon
    creation).


    ## Base URL

    The base URL includes your username:
    `https://api.paubox.net/v1/orca/<USERNAME>`


    Replace `<USERNAME>` with your API endpoint username.
  contact:
    name: Paubox Support
    url: https://www.paubox.com
  version: 1.0.0
servers:
  - url: https://api.paubox.net/v1/orca/{username}
    description: Production server
    variables:
      username:
        description: Your API endpoint username
        default: YOUR_USERNAME
security:
  - TokenAuth: []
tags:
  - name: subscribers
    description: Subscriber management operations
  - name: analytics
    description: Campaign analytics and reporting operations
  - name: campaign_mailings
    description: Campaign mailing management and sending operations
  - name: drip_campaigns
    description: Drip campaign management and automation operations
  - name: subscription_lists
    description: Subscription list management operations
  - name: tracking_links
    description: Tracking link analytics and data operations
paths:
  /subscribers:
    get:
      tags:
        - subscribers
      summary: Fetch subscribers
      description: Return json data about subscribers
      operationId: getSubscribers
      parameters:
        - name: items
          in: query
          description: Number of records to return
          required: false
          schema:
            maximum: 1000
            minimum: 1
            type: integer
            default: 50
        - name: page
          in: query
          description: For pagination of results
          required: false
          schema:
            minimum: 1
            type: integer
            default: 1
        - name: search
          in: query
          description: Search term
          required: false
          schema:
            pattern: ^[a-zA-Z0-9\s]*$
            type: string
        - name: order_by
          in: query
          description: Field to order by
          required: false
          schema:
            type: string
            enum:
              - first_name
              - last_name
              - email
              - created_at
              - updated_at
            default: created_at
        - name: order
          in: query
          description: Order direction
          required: false
          schema:
            type: string
            enum:
              - asc
              - desc
            default: desc
        - name: subscription_list_id
          in: query
          description: >-
            Filter by subscription list ID (defaults to all subscribers/default
            subscription list)
          required: false
          schema:
            type: string
      responses:
        '200':
          description: Successful response
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/SubscribersResponse'
        '400':
          $ref: '#/components/responses/BadRequest'
        '401':
          $ref: '#/components/responses/Unauthorized'
        '500':
          $ref: '#/components/responses/InternalServerError'
components:
  schemas:
    SubscribersResponse:
      type: object
      properties:
        data:
          type: array
          items:
            $ref: '#/components/schemas/Subscriber'
    Subscriber:
      type: object
      properties:
        id:
          type: string
          description: Unique identifier for the subscriber
        type:
          type: string
          description: Resource type
          enum:
            - subscriber
        attributes:
          $ref: '#/components/schemas/Subscriber_attributes'
    Error:
      type: object
      properties:
        error:
          type: string
          description: Error message
        code:
          type: string
          description: Error code
        details:
          type: object
          description: Additional error details
    Subscriber_attributes:
      required:
        - email
        - unsubscribed
      type: object
      properties:
        email:
          type: string
          description: Subscriber's email address
          format: email
        first_name:
          type: string
          description: Subscriber's first name
        last_name:
          type: string
          description: Subscriber's last name
        unsubscribed:
          type: boolean
          description: Whether the subscriber is unsubscribed
  responses:
    BadRequest:
      description: Bad request
      content:
        application/json:
          schema:
            $ref: '#/components/schemas/Error'
    Unauthorized:
      description: Unauthorized
      content:
        application/json:
          schema:
            $ref: '#/components/schemas/Error'
    InternalServerError:
      description: Internal server error
      content:
        application/json:
          schema:
            $ref: '#/components/schemas/Error'
  securitySchemes:
    TokenAuth:
      type: apiKey
      description: >-
        Token-based authentication. Use format: "Token token=<API_KEY>" where
        <API_KEY> is your API key
      name: authorization
      in: header

````