Get Application
Retrieve details of a specific application using the Docstron API. This endpoint allows you to fetch application information, status, and metadata.
Endpoint
Section titled “Endpoint”GET https://api.docstron.com/v1/applications/{app_id}
Authentication
Section titled “Authentication”This endpoint requires authentication using a Bearer token. Include your API key in the Authorization header:
Authorization: Bearer YOUR_API_KEY
Parameters
Section titled “Parameters”Path Parameters
Parameter | Type | Required | Description |
---|---|---|---|
app_id | string | Yes | The unique identifier of the application (e.g., app-7b4d78fb-820c-4ca9-84cc-46953f211234 ) |
Request Examples
Section titled “Request Examples”curl --location 'https://api.docstron.com/v1/applications/app-7b4d78fb-820c-4ca9-84cc-46953f211234' \ --header 'Content-Type: application/json' \ --header 'Authorization: Bearer YOUR_API_KEY' \ --data ''
Response
Section titled “Response”200 - Success Response
{ "success": true, "message": "Request successful", "data": { "app_id": "app-7b4d78fb-820c-4ca9-84cc-46953f211234", "name": "App 1", "description": "App 1 description", "is_active": true, "created_at": "2025-10-12T17:06:14", "updated_at": "2025-10-13T16:20:39" }}
Response Fields
Section titled “Response Fields”Field | Type | Description |
---|---|---|
success | boolean | Indicates if the request was successful |
message | string | A message describing the response |
data | object | The application details object |
data.app_id | string | Unique application identifier |
data.name | string | Name of the application |
data.description | string | Description of the application (may be empty) |
data.is_active | boolean | Whether the application is active (true ) or inactive (false ) |
data.created_at | string | Timestamp when the application was created |
data.updated_at | string | Timestamp when the application was last updated |
Error Responses
Section titled “Error Responses”404 - Application Not Found
Returned when the provided app_id
does not exist or is invalid.
{ "success": false, "message": "Application not found.", "data": []}
Common causes:
- Invalid or mistyped
app_id
- Application has been deleted
- The application belongs to a different account
Solution: Verify the app_id
is correct. You can list all applications using the Get All Applications endpoint.
500 - Internal Server Error
Returned when an unexpected server error occurs while retrieving the application.
{ "success": false, "message": "Failed to get the application.", "data": []}
Common causes:
- Temporary server issue
- Database connectivity problem
- Service maintenance
Solution: Wait a few moments and retry the request. If the problem persists, contact support@docstron.com.
Need Help?
Section titled “Need Help?”If you encounter issues or have questions:
- 📧 Email: support@docstron.com
- 📚 Documentation: API Reference
- 💬 Live Support: Available in your dashboard