Get All Projects

This endpoint retrieves a list of all active signature request documents that are still waiting for signature, approval, manual validation, or processing for completion. It returns comprehensive information for each document, including file details, timestamps, sender and signer details, and status.

HTTP Method and URL

GET
{{host}}/api/v2/projects/processing/all-files

Authentication Requirements

Requires a valid user token provided in the Authorization header (Bearer token).
Example:
Authorization: Bearer {USER-TOKEN}

Path and Query Parameters

• user_type (string, required): Type of user (e.g., ENTERPRISE_API)

• status (string, required): Status of the projects to be retrieved (e.g., Processing)

• user_items_only (string, required): Indicates whether to include user items only (e.g., no)

• api_integrated_projects_only (string, required): Indicates whether to include API integrated projects only (e.g., no)

Example Request

plaintextGET {{host}}/api/v2/projects/processing/    all-files?user_type=ENTERPRISE_API&    status=Processing&user_items_only=no&    api_integrated_projects_only=noAuthorization: Bearer {USER-TOKEN}

Example Successful Response

json{    "message": "Success",    "data": [        {            "access_type": "string",            "id": 123,            "sender_id": 456,            "uuid": "abc-123-uuid",            "reference_number": "REF-001",            "type": "signature",            "category": "contract",            "source": "web",            "status": "Processing",            "name": "NDA Agreement",            "file_name": "nda_agreement.                pdf",            "url": "https://example.com/                files/nda_agreement.pdf",            "description": "Non-disclosure                 agreement for Project X",            "signatory_type": "individual",            "validation_status": "pending",            "signer_mark_page": "2",            "signature_timestamp_label":                 "2024-06-01T12:00:00Z",            "email_sender":                 "[email protected]",            "email_subject": "Please sign                 the NDA",            "email_message": "Kindly                 review and sign the                 attached NDA.",            "meta_data": {                "1": {                    "pageNumber": 1,                    "width": 612,                    "height": 792                },                "pages": 5            },            "created_by": 789,            "updated_by": 789,            "sent_at":                 "2024-06-01T12:00:00Z",            "completed_at": null,            "created_at":                 "2024-05-31T09:00:00Z",            "deleted_at": null,            "schedule_date": null,            "files": [                {                    "id": 321,                    "project_id": 123,                    "file_name":                         "nda_agreement.pdf"                }            ]        }    ]}

Error Responses

• 401 Unauthorized: Invalid or missing authentication token.

• 403 Forbidden: Insufficient permissions to access this resource.

• 400 Bad Request: Missing or invalid query parameters.

• 500 Internal Server Error: Unexpected server error.

Usage Notes

• Ensure all required query parameters are provided.

• The endpoint returns all documents with the specified status and filters.

• Use the "user_items_only" and "api_integrated_projects_only" parameters to control the scope of returned projects.

• The "data" array may be empty if no matching projects are found.