Appearance
Get documents custom schema
Get project documents in a custom schema defined in Project settings
Endpoint
GET /api/v1/external/projects/{projectUuid}/documents/customHeaders
| Header | Type | Required | Description |
|---|---|---|---|
| Authorization | string | Yes | Bearer token for authentication |
Parameters
| Parameter | Type | Required | Description |
|---|---|---|---|
| projectUuid | string | Yes | The UUID of the project to upload the document to. Can be found in the Recognito application. |
Query parameters
| Parameter | Type | Required | Description | Example |
|---|---|---|---|---|
| from | string | Yes | The start date to fetch documents from. | 2022-01-01 |
| status | string | Yes | The status of the documents to fetch. | pending, approved, validated |
Response
Success Response (200 OK)
json
{
"status": "success",
"documents": [
{
}
]
}Error Response (400 Bad Request)
json
{
"error": "string",
"message": "string"
}Example
Request
bash
curl -X GET https://apiv2.recognito.io/api/v1/external/projects/{projectUuid}/documents/custom?from=2022-01-01&status=approved \
-H "Authorization: Bearer YOUR_API_KEY"Response
json
{
"status": "success",
"documents": [
{
}
]
}