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

# List documents in a dataset



## OpenAPI

````yaml /api-reference/openapi.json get /Dataset/{datasetId}/document
openapi: 3.0.1
info:
  title: Starleads public API documentation
  description: >
    Welcome to the Starleads Public API documentation. This API provides public
    access to Starleads services, allowing developers and growth-hackers to
    interact with campaign-related data.

    ***

    ### Base endpoint

    ```https://api.starleads.co```

    ***

    ### Errors

    The API uses standard HTTP status codes to indicate the success or failure
    of the API call. In case of failure, the body of the response will be JSON
    in the following format:

    ```

    {
      "type": "https://tools.ietf.org/html/rfc7231#section-6.5.1",
      "title": "Bad Request",
      "status": 400,
      "detail": "No campaign exists with campaignId : 11111111"
    }

    ```

    The ```type``` property is a link to a general description of the error
    type.

    ***

    ### Authentification

    Authentication for the API is handled with an API key that must be provided
    as a ```X-Api-Key``` header for every request.<br>

    **API keys are supposed to be a secret that only the client and server know.
    Please remember to not share them with anyone.**<br>

    You can find your API keys when authenticated in your Starleads profile
    :<br> ![Api key menu option](../images/api-menu-option-screenshot.png)
  version: v1
  x-logo:
    url: https://api.starleads.co/images/starleads-logo.png
servers: []
security: []
tags:
  - name: Agent
    description: >-
      Manage your AI agent's prompt. These endpoints allow you to read and
      update the prompt that drives your agent's behavior during calls.
  - name: CampaignField
    description: >-
      CampaignFields enables users to specify customizable fields within their
      campaigns. These fields serve as placeholders (e.g., ```{lastname}```)
      that can be dynamically filled with corresponding data when creating
      prompts, providing flexibility in tailoring campaign content based on
      specific variables.<br>**Those are the keys of the ```databag``` field of
      the request payload to add a new ```CampaignItem``` to a campaign.**
  - name: CampaignItem
    description: Represents prospects entries related to a campaign
  - name: Consumption
    description: >-
      Track your company's credit consumption. These endpoints expose your
      current balance, usage and billing period so you can build budget
      monitoring on top of the API.
  - name: Subscription
    description: >-
      Inspect your subscription contract: the plan you are on, your subscription
      status, the features currently active and your effective limits. No
      pricing information is exposed.
paths:
  /Dataset/{datasetId}/document:
    get:
      tags:
        - Dataset
      summary: List documents in a dataset
      parameters:
        - name: X-Api-Key
          in: header
          description: API key for authentication
          required: true
          schema:
            type: string
        - name: datasetId
          in: path
          required: true
          schema:
            type: string
        - name: PageNumber
          in: query
          schema:
            maximum: 2147483647
            minimum: 1
            type: integer
            description: Page number (starts at 1)
            format: int32
        - name: PageSize
          in: query
          schema:
            maximum: 100
            minimum: 1
            type: integer
            description: Number of items per page (1 to 100, default 50)
            format: int32
        - name: keywords
          in: query
          schema:
            type: string
        - name: run
          in: query
          schema:
            type: string
      responses:
        '200':
          description: Success
          content:
            text/plain:
              schema:
                $ref: '#/components/schemas/PublicDocumentPaginatedResponse'
            application/json:
              schema:
                $ref: '#/components/schemas/PublicDocumentPaginatedResponse'
            text/json:
              schema:
                $ref: '#/components/schemas/PublicDocumentPaginatedResponse'
        '400':
          description: Bad Request
          content:
            text/plain:
              schema:
                $ref: '#/components/schemas/ProblemDetails'
            application/json:
              schema:
                $ref: '#/components/schemas/ProblemDetails'
            text/json:
              schema:
                $ref: '#/components/schemas/ProblemDetails'
        '401':
          description: Unauthorized
          content:
            text/plain:
              schema:
                $ref: '#/components/schemas/ProblemDetails'
            application/json:
              schema:
                $ref: '#/components/schemas/ProblemDetails'
            text/json:
              schema:
                $ref: '#/components/schemas/ProblemDetails'
components:
  schemas:
    PublicDocumentPaginatedResponse:
      type: object
      properties:
        data:
          type: array
          items:
            $ref: '#/components/schemas/PublicDocument'
          description: List of items for the current page
          nullable: true
        total:
          type: integer
          description: Total number of items across all pages
          format: int32
        pageNumber:
          type: integer
          description: Current page number
          format: int32
        pageSize:
          type: integer
          description: Number of items per page
          format: int32
      additionalProperties: false
      description: Paginated response wrapper
    ProblemDetails:
      type: object
      properties:
        type:
          type: string
          nullable: true
        title:
          type: string
          nullable: true
        status:
          type: integer
          format: int32
          nullable: true
        detail:
          type: string
          nullable: true
        instance:
          type: string
          nullable: true
      additionalProperties: {}
    PublicDocument:
      type: object
      properties:
        id:
          type: string
          description: Document identifier
          nullable: true
        name:
          type: string
          description: Original filename
          nullable: true
        size:
          type: integer
          description: File size in bytes
          format: int64
          nullable: true
        status:
          type: string
          description: Parsing status
          nullable: true
        chunkMethod:
          type: string
          description: Chunking method used
          nullable: true
        createdAt:
          type: string
          description: Upload timestamp
          format: date-time
          nullable: true
      additionalProperties: false
      description: Public representation of a document

````