SIsignalshq
CLIENT
Client Document Management
DMS Folders

Get folder contents

Get folders and documents in a specific folder or root level (folders first, then documents) with extraction and workflow status

get/internal/api/clients/{client_id}/dms/folders/contents

Request

  • Base URL
    https://api.signalshq.io (the document declares no server; this is the origin it was published from)
  • Auth
    OAuth 2
    Password
    Token URL: /auth/login

Path parameters

client_idstring uuid required

Client ID

Query parameters

folder_idstring nullable

Folder ID (empty/null for root level)

sort_bystring

Sort field (name, created_at, updated_at, type)

sort_orderstring

Sort order (asc, desc)

tax_yearstring[] nullable

Filter by tax year (multiple values allowed)

doc_yearstring[] nullable

Filter by document year (multiple values allowed)

extractionboolean nullable

Filter by extraction status (true=only documents that have been processed)

doc_typestring[] nullable

Filter by legacy document type (e.g. W2, FORM_1099_INT)

document_type_idstring[] nullable

Filter by canonical document_type_id (the new source-of-truth column; matches reclassified documents correctly where the legacy doc_type would not)

extraction_statusstring[] nullable

Filter by extraction status (e.g. COMPLETED, FAILED, IN_PROGRESS)

workflow_statusstring[] nullable

Filter by workflow status (e.g. APPROVED, CREATED, IN_PROGRESS)

needs_attentionboolean nullable

When true, return only items needing CPA action: failed/unsupported documents and multi-form bundles whose rollup is ACTION_NEEDED or ALL_FAILED (with their children).

folderviewboolean

Include folders in response (false=flat list of documents only)

querystring nullable

Search term to filter folders and documents by name, description, or filename

pageinteger

Page number (1-based)

page_sizeinteger

Number of items per page

Response

Successful Response

Example response

{
  "items": [
    {
      "derived_document_type": "W-2",
      "document_type_identifier": "SCH_K1_1065",
      "document_type_display_name": "Form W-2",
      "party_display": {
        "initial": "P",
        "short": "Priya",
        "full": "Priya Raghunathan · Spouse",
        "role_label": "Spouse"
      },
      "document_classification_display_name": "Form W-2",
      "version": 2,
      "is_latest": true,
      "is_extraction_allowed": true
    }
  ]
}

Changes

No recorded changes to this operation across all 1 revision of this API.