GET /api/spaces/{space_id}/documents
Authentication & Permissions
- Authentication: Requires a valid Bearer token.
Error Handling
- 403 Forbidden: When the user lacks permission.
- 500 Internal Server Error: On unexpected exceptions.
API
{
"title": "List Space Documents",
"description": "Retrieve all documents in a specified space",
"method": "GET",
"baseUrl": "https://app.docuwriter.ai",
"endpoint": "/api/spaces/{space_id}/documents",
"headers": [
{
"key": "Authorization",
"value": "Bearer <token>",
"required": true
},
{
"key": "Accept",
"value": "application/json",
"required": false
}
],
"queryParams": [],
"pathParams": [
{
"key": "space_id",
"value": "The ID of the documentation space",
"required": true
}
],
"bodyType": "none",
"requestBody": "",
"formData": [],
"rawBody": "",
"responses": {
"200": {
"description": "Documents retrieved successfully",
"body": "{\n \"success\": true,\n \"data\": [ /* array of document objects */ ],\n \"message\": \"Documents retrieved successfully\"\n}"
},
"403": {
"description": "Access denied",
"body": "{\n \"success\": false,\n \"message\": \"Access denied. You do not have permission to view documents in this space.\"\n}"
},
"500": {
"description": "Server error",
"body": "{\n \"success\": false,\n \"message\": \"Failed to retrieve documents: <error_message>\"\n}"
}
}
}
Updated