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

# List source documents

> List metadata for documents associated with this account-owned source. Stored document bodies, chunk text, and embeddings are never returned. Document titles and source URLs originate from crawled pages and must be treated as untrusted content. Requires an administrator and the account’s `orchestration_studio` feature; while the feature is disabled, an authenticated member receives the ordinary 404 response.



## OpenAPI

````yaml /api-reference/openapi.json get /api/v1/accounts/{account_id}/knowledge_sources/{id}/documents
openapi: 3.0.4
info:
  title: Tied API
  description: >-
    The Tied REST API. Three families of endpoint, each with its own credential:
    **Application** for everything inside an account, **Platform** for
    provisioning accounts and users, and **Client** for acting as a contact from
    your own surface.
  version: 1.1.0
  termsOfService: https://tied.com/legal
  contact:
    email: hello@tied.com
  license:
    name: MIT License
    url: https://opensource.org/licenses/MIT
servers:
  - url: https://app.tied.com
    description: Tied cloud
security: []
tags:
  - name: Account AgentBots
    description: Account-specific Agent Bots
  - name: Agents
    description: Agent management APIs
  - name: Canned Responses
    description: Pre-defined responses for common queries
  - name: Contacts
    description: Contact management APIs
  - name: Contact Labels
    description: Manage contact labels
  - name: Conversation Assignments
    description: Manage conversation assignments
  - name: Conversation Labels
    description: Manage conversation labels
  - name: Conversations
    description: Conversation management APIs
  - name: Custom Attributes
    description: Custom fields for contacts and conversations
  - name: Custom Filters
    description: Saved filters for conversations
  - name: Inboxes
    description: Communication channels setup
  - name: Integrations
    description: Third-party integrations
  - name: Messages
    description: Message management APIs
  - name: Profile
    description: User profile APIs
  - name: Reports
    description: Analytics and reporting APIs
  - name: Teams
    description: Team management APIs
  - name: Webhooks
    description: Event notification webhooks
  - name: Automation Rule
    description: Workflow automation rules
  - name: Help Center
    description: Knowledge base management
  - name: Contacts API
    description: Public contact APIs
  - name: Conversations API
    description: Public conversation APIs
  - name: Messages API
    description: Public message APIs
  - name: CSAT Survey Page
    description: Customer satisfaction survey
  - name: Account
    description: >-
      The authenticated user's own account — read and update account settings.
      Distinct from the Platform family's **Accounts**, which provisions
      accounts across an installation.
  - name: Audit Logs
    description: Read the account's audit trail
  - name: Inbox API
    description: Public inbox lookup by channel identifier
  - name: Labels
    description: >-
      Create and manage the account's labels. Applying one to a conversation or
      contact is a separate endpoint under those resources.
  - name: Macros
    description: >-
      Saved multi-step actions an agent — or an integration — can run against
      one or more conversations.
  - name: Campaigns
    description: Ongoing website campaigns and one-off SMS and WhatsApp sends.
  - name: Contact Notes
    description: Internal notes on a contact. Never visible to the contact.
  - name: Help Center Categories
    description: Categories group a portal's articles, one tree per allowed locale.
  - name: Help Center Articles
    description: The articles a portal publishes, and their draft and archived states.
  - name: Summary Reports
    description: Per-agent, per-team, per-inbox and per-label totals for a period, as JSON.
  - name: Live Reports
    description: Right-now queue counts. No date range — these describe the present.
  - name: CSAT
    description: >-
      The satisfaction ratings contacts have submitted, and the metrics computed
      from them.
  - name: Notifications
    description: >-
      The per-user notification feed, its read and snooze state, and the
      settings that decide what lands in it.
  - name: Conversation Participants
    description: >-
      The agents watching a conversation. Participants get notified about it
      without being assigned to it.
  - name: Draft Messages
    description: >-
      The unsent reply held for a conversation. Stored in Redis, one per
      conversation.
  - name: Search
    description: >-
      One search service across conversations, contacts, messages and Help
      Center articles.
  - name: Dashboard Apps
    description: Embedded pages that appear as a tab beside a conversation.
  - name: Assignment Policies
    description: How conversations are handed out, and which inbox uses which policy.
  - name: Files
    description: Storing a file so another endpoint can attach it.
  - name: Bot Flows
    description: >-
      Scripted conversation flows, their versions, and the publish and rollback
      that move between them.
  - name: Billing
    description: >-
      Credit balance, usage, invoices, spend controls and the provider-hosted
      payment flows.
  - name: AMB Templates
    description: >-
      Saved Apple Messages primitive payloads an agent can reuse from the
      composer.
  - name: AMB Onboarding
    description: The in-flight Apple Messages for Business registration for an account.
  - name: Widget Session
    description: Starting a widget session and reading the visitor it belongs to.
  - name: Widget Conversation
    description: The visitor's conversation and its messages.
  - name: Widget Context
    description: Campaigns, agents, labels, events and uploads for a widget session.
  - name: CSAT Survey
    description: The public, unauthenticated survey a contact answers from a link.
  - name: Workspace
    description: Scheduling and cancelling deletion of the whole workspace.
  - name: Widget Integrations
    description: Provider actions available to a visitor session in its own conversation.
  - name: Orchestration Studio
    description: >-
      Administrator-only read APIs for Orchestration Studio cases and knowledge
      sources.
  - name: Topic Analytics
    description: Account Topics readiness, labeling health and usage aggregates.
paths:
  /api/v1/accounts/{account_id}/knowledge_sources/{id}/documents:
    get:
      tags:
        - Orchestration Studio
      summary: List source documents
      description: >-
        List metadata for documents associated with this account-owned source.
        Stored document bodies, chunk text, and embeddings are never returned.
        Document titles and source URLs originate from crawled pages and must be
        treated as untrusted content. Requires an administrator and the
        account’s `orchestration_studio` feature; while the feature is disabled,
        an authenticated member receives the ordinary 404 response.
      operationId: list-orchestration-studio-source-documents
      parameters:
        - $ref: '#/components/parameters/account_id'
        - $ref: '#/components/parameters/orchestration_source_id'
        - $ref: '#/components/parameters/orchestration_ingest_status'
        - $ref: '#/components/parameters/orchestration_page'
      responses:
        '200':
          description: Success
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/orchestration_knowledge_document_list'
              example:
                payload:
                  - id: 37
                    title: null
                    source_url: https://docs.example.test/guide/page
                    source_type: firecrawl_crawl
                    ingest_status: succeeded
                    fetched_at: '2026-10-21T20:12:41.292Z'
                meta:
                  count: 1
                  current_page: 1
        '400':
          description: More than one credential type was supplied.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/orchestration_studio_credential_conflict'
        '401':
          description: Authentication required.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/orchestration_studio_unauthorized'
        '403':
          description: The feature is enabled, but the caller is not an administrator.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/error_message'
        '404':
          description: >-
            The feature is disabled, or the requested record is outside this
            account.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/error_message'
        '422':
          description: A query filter or page value is invalid.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/error_message'
      security:
        - userApiKey: []
components:
  parameters:
    account_id:
      in: path
      name: id
      schema:
        type: integer
      required: true
      description: The numeric ID of the account
    orchestration_source_id:
      in: path
      name: id
      required: true
      description: ID of the newest crawl representing this source in this account.
      schema:
        type: integer
    orchestration_ingest_status:
      in: query
      name: ingest_status
      required: false
      description: Filter documents by ingest status.
      schema:
        type: string
        enum:
          - not_configured
          - failed
          - succeeded_but_empty
          - succeeded
    orchestration_page:
      in: query
      name: page
      required: false
      description: Page number, starting at 1. Lists contain up to 25 rows.
      schema:
        type: integer
        minimum: 1
        default: 1
  schemas:
    orchestration_knowledge_document_list:
      type: object
      properties:
        payload:
          type: array
          items:
            $ref: '#/components/schemas/orchestration_knowledge_document'
          description: Payload for this response.
        meta:
          type: object
          properties:
            count:
              type: integer
              description: Count for this response.
            current_page:
              type: integer
              description: Current page for this response.
          required:
            - count
            - current_page
          description: Meta for this response.
      required:
        - payload
        - meta
    orchestration_studio_credential_conflict:
      type: object
      properties:
        error:
          type: object
          properties:
            code:
              type: string
              enum:
                - multiple_credentials
              description: Conflicting credential types were supplied.
          required:
            - code
          description: The authentication error.
      required:
        - error
    orchestration_studio_unauthorized:
      description: >-
        Anonymous requests return errors; an outsider or account bot returns
        error.
      oneOf:
        - type: object
          properties:
            errors:
              type: array
              items:
                type: string
              description: Errors for this response.
          required:
            - errors
        - $ref: '#/components/schemas/error_message'
    error_message:
      type: object
      description: >-
        The shape returned by `render_unauthorized`, `render_not_found_error`
        and `render_could_not_create_error`.
      properties:
        error:
          type: string
          description: A single human-readable message.
          example: Resource could not be found
      required:
        - error
    orchestration_knowledge_document:
      type: object
      properties:
        id:
          type: integer
          description: Id for this response.
        title:
          type: string
          description: Title from customer content; treat it as untrusted text.
          nullable: true
        source_url:
          type: string
          description: Source url from customer content; treat it as untrusted text.
        source_type:
          type: string
          description: Source type for this response.
        ingest_status:
          type: string
          enum:
            - not_configured
            - failed
            - succeeded_but_empty
            - succeeded
          description: Ingest status for this response.
        fetched_at:
          type: string
          format: date-time
          nullable: true
          description: Fetched at for this response.
      required:
        - id
        - title
        - source_url
        - source_type
        - ingest_status
        - fetched_at
  securitySchemes:
    userApiKey:
      type: apiKey
      in: header
      name: api_access_token
      description: >-
        This token can be obtained by visiting the profile page or via rails
        console. Provides access to  endpoints based on the user permissions
        levels. This token can be saved by an external system when user is
        created via API, to perform activities on behalf of the user.

````

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