For AI agents: a documentation index is available at the root level at /llms.txt and /llms-full.txt. Append /llms.txt to any URL for a page-level index, or .md for the markdown version of any page.
Scout DocsAccess Scout
API & SDK
API & SDK
  • Endpoints
      • GETList all documents in a table.
      • POSTCreate a document in a table.
      • POSTUpdate multiple documents in a table.
      • GETGet a document by ID.
      • PUTUpdate a document by ID.
      • DELDelete a document by ID.
      • POSTDelete multiple document by ID.
LogoLogo
Scout DocsAccess Scout
EndpointsDocuments

Get a document by ID.

Beta
GET
https://api.scoutos.com/v2/collections/:collection_id/tables/:table_id/documents/:document_id
GET
/v2/collections/:collection_id/tables/:table_id/documents/:document_id
$curl https://api.scoutos.com/v2/collections/collection_id/tables/table_id/documents/document_id \
>     -H "Authorization: Bearer <token>"
1{
2  "data": {
3    "document_id": "a1b2c3d4-e5f6-7890-ab12-cd34ef567890",
4    "created_by": {
5      "type": "user",
6      "details": {
7        "api_key": {
8          "key_id": "key_9876543210abcdef",
9          "permissions": [
10            "read",
11            "write"
12          ]
13        }
14      }
15    },
16    "last_updated_by": {
17      "type": "user",
18      "details": {
19        "api_key": {
20          "key_id": "key_1234567890abcdef",
21          "permissions": [
22            "read",
23            "write",
24            "update"
25          ]
26        }
27      }
28    },
29    "data": {
30      "title": "Quarterly Financial Report",
31      "status": "approved",
32      "amount": 125000,
33      "currency": "USD"
34    },
35    "document_data_id": "dd123456-7890-4abc-def0-1234567890ab",
36    "created_at": "2024-01-15T09:30:00Z",
37    "last_updated_at": "2024-01-20T14:45:00Z",
38    "revision_id": "rev_20240115_001",
39    "job_id": "job_20240115_1001",
40    "sync_id": "sync_20240115_2001",
41    "studio_row_id": "row_00012345",
42    "cells": {
43      "A1": "Revenue",
44      "B1": 125000,
45      "C1": "USD"
46    }
47  }
48}
Route handler for getting a document
Was this page helpful?
Previous

Update a document by ID.

Next
Built with

Authentication

AuthorizationBearer

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

Path parameters

collection_idstringRequired
table_idstringRequired
document_idstringRequired

Response

Successful Response
dataobject or null

Errors

422
Unprocessable Entity Error