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

# Get All Bulk Files

> Returns a paginated list of all bulk verification files submitted under the authenticated API key. Supports pagination and optional search.



## OpenAPI

````yaml GET /verify/bulk/files
openapi: 3.1.0
info:
  title: Deliverable Docs API
  description: API for email verification and task status.
  license:
    name: MIT
  version: 1.0.0
servers:
  - url: https://api.deliverable.co/gateway
security:
  - apiKeyAuth: []
paths:
  /verify/bulk/files:
    get:
      summary: Get All Bulk Files
      description: >-
        Returns a paginated list of all bulk verification files submitted under
        the authenticated API key. Supports pagination and optional search.
      parameters:
        - name: page
          in: query
          required: true
          description: Page number for pagination
          schema:
            type: integer
            example: 1
        - name: pageSize
          in: query
          required: true
          description: Number of results per page
          schema:
            type: integer
            example: 10
        - name: search
          in: query
          required: false
          description: Optional search term to filter files by name
          schema:
            type: string
            example: my-list
      responses:
        '200':
          description: List of bulk files returned successfully
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/GetBulkFilesResponse'
        '400':
          description: Missing or invalid query parameters
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Error'
        '401':
          description: Invalid API key
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Error'
        '402':
          description: Subscription expired or payment required
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Error'
        '429':
          description: Rate limit exceeded
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Error'
components:
  schemas:
    GetBulkFilesResponse:
      type: object
      properties:
        message:
          allOf:
            - $ref: '#/components/schemas/MessageEnvelope'
            - properties:
                description:
                  example: Bulk files fetched successfully
        data:
          type: object
          properties:
            files:
              type: array
              items:
                type: object
                properties:
                  _id:
                    type: string
                    example: file_abc123xyz
                  file_name:
                    type: string
                    example: my-email-list
                  state:
                    type: string
                    enum:
                      - pending
                      - processing
                      - completed
                      - failed
                    example: completed
                  type:
                    type: string
                    enum:
                      - api
                      - website
                    example: api
                  service_name:
                    type: string
                    example: verify_email
                  options:
                    type: object
                    properties:
                      credit_usage:
                        type: integer
                        description: Credits consumed for this file
                        example: 100
                      credit_refund:
                        type: integer
                        description: Credits refunded for unverifiable emails
                        example: 2
                  meta_data:
                    type: object
                    properties:
                      deliverable:
                        type: integer
                        example: 80
                      undeliverable:
                        type: integer
                        example: 15
                      unknown:
                        type: integer
                        example: 3
                      risky:
                        type: integer
                        example: 2
                  createdAt:
                    type: string
                    format: date-time
                    example: '2026-01-01T10:00:00.000Z'
                  updatedAt:
                    type: string
                    format: date-time
                    example: '2026-01-01T10:05:00.000Z'
            totalCount:
              type: integer
              description: Total number of files matching the query
              example: 25
            page:
              type: integer
              example: 1
            pageSize:
              type: integer
              example: 10
    Error:
      type: object
      properties:
        error:
          type: integer
          format: int32
          example: 400
        message:
          type: string
          example: Invalid request body
    MessageEnvelope:
      type: object
      properties:
        status:
          type: string
          example: success
        statusCode:
          type: integer
          example: 200
        description:
          type: string
          example: Operation completed successfully
  securitySchemes:
    apiKeyAuth:
      type: apiKey
      in: header
      name: x-api-key
      description: API key for authentication. Pass your API key in the x-api-key header.

````