Skip to main content
GET
/
documents
/
{connector_id}
List documents for a connector
curl --request GET \
  --url https://{subdomain}.withrealm.com/api/external/alpha/documents/{connector_id} \
  --header 'Authorization: Bearer <token>'
{
  "documents": [
    {
      "title": "<string>",
      "content": "<string>",
      "contentType": "markdown",
      "id": "<string>",
      "url": "<string>",
      "createdAt": "2023-11-07T05:31:56Z",
      "updatedAt": "2023-11-07T05:31:56Z",
      "meta": {},
      "readAccess": [
        "<string>"
      ]
    }
  ],
  "nextCursor": "<string>"
}
These endpoints require a custom API connector. See Custom API for setup instructions.

​
Pagination

The endpoint uses cursor-based pagination. By default, only document IDs are returned. Use the fields parameter to request additional fields like title, content, url, and meta.
  1. Make a request without a cursor to get the first page of results
  2. Use the nextCursor from the response to get the next page
  3. Continue until nextCursor is not present

​
Rate Limits

600 requests per minute.

Authorizations

​
Authorization
string
header
required

Bearer authentication header of the form Bearer <token>, where <token> is your auth token.

Response

Success

​
documents
object[]
required
​
nextCursor
string