CapableDocs

Search the API docs

Find an endpoint or guide

Get an API key

RecordsList documents

Records

List documents

The data room index: every stored document, its folder and the security or stakeholder it belongs to.
GET/api/v1/documents

Requires an API key with the documents:read scope · How keys work

Response 200

Document metadata under data. Files themselves are downloaded in the app.

  • dataobject[]

    The documents.

    ›Show 8 attributes
    • idstring

      Unique id.

    • namestring

      File name.

    • folderstring | null

      Data room folder.

    • mimeTypestring | null

      File type, such as application/pdf.

    • sizenumber | null

      Size in bytes.

    • securityIdstring | null

      The security it is attached to.

    • stakeholderIdstring | null

      The stakeholder it is attached to.

    • createdAttimestamp

      When it was added, ISO 8601 in UTC.

Example

Request
curl https://capable.so/api/v1/documents \
  -H "Authorization: Bearer $CAPABLE_API_KEY"
Response · 200 OK
JSON
{
  "data": [
    {
      "id": "doc_e1n4s7p2l9xa",
      "name": "Stock Option Grant - Priya Raman - OPT-9.pdf",
      "folder": "Equity plans",
      "mimeType": "application/pdf",
      "size": 184233,
      "securityId": "sec_7tq0c2n5vz3d",
      "stakeholderId": "stk_4m8q2xw7ka1p",
      "createdAt": "2025-03-21T00:14:02.000Z"
    }
  ]
}

Errors

StatusWhen
401 UnauthorizedThe key is missing, invalid or revoked, or its creator lost access.
402 Payment requiredThe company has no active plan in good standing: its trial ended without one, a payment has failed for over 21 days, or its subscription is paused or has ended.
403 ForbiddenThe key does not have the documents:read scope.
429 Too many requestsThe key went over its rate limit. Wait for Retry-After seconds.

Every error has the same shape. See Errors, limits and conventions.