Get a document

Get a specific document by ID. This endpoint requires a data source ID. To get started:

1. Go to the Data sources page
2. Create a new API data source
3. Copy the data source ID from the data source details page
4. Use this ID in the path parameter

Rate Limits

600 requests per minute.

GET /documents/{data_source_id}/{document_id}

Get a document

cURL

curl --request GET \
  --url https://{subdomain}.withrealm.com/api/external/alpha/documents/{data_source_id}/{document_id} \
  --header 'Authorization: Bearer <token>'

200

{
  "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>"
  ]
}

These endpoints require a custom API data source. See Custom API for setup instructions.

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.

Path Parameters

data_source_id · string · required

document_id · string · required

Query Parameters

fields · enum<string>[]

Comma-separated list of fields to return. If not provided, only document IDs are returned.

Available options: id, title, content, content_type, url, document_created_at, document_updated_at, meta

Response

200

application/json

Success

title · string · required

content · string · required

contentType · enum<string> · required

Available options: markdown, text, html

id · string

Optional unique identifier for the document. We enforce uniqueness in our end. If not provided, a UUID will be generated automatically and returned in the response. Must be alphanumeric and can include underscores and hyphens. The order of the documents in the response is the same as the order of the documents in the request, so you can match any generated IDs.

Pattern: ^[a-zA-Z0-9_-]+$

url · string<uri>

createdAt · string<date-time>

UTC timestamp in ISO 8601 format (e.g. '2024-03-20T10:00:00Z')

updatedAt · string<date-time>

UTC timestamp in ISO 8601 format (e.g. '2024-03-20T10:00:00Z')

meta · object

Show child attributes

readAccess · string[]

Email addresses of the users that have read access to the document. If not provided, the document can be seen by anyone in Realm.