SmartMatchApp

List Task Files

Retrieve a paginated list of files attached to a specific task.

Example Requests:

List all files for a task:

curl "https://<your-agency>.smartmatchapp.com/api3/tasks/<task_id>/files/" \
    -u <token>: \
    -X GET

List with pagination:

curl "https://<your-agency>.smartmatchapp.com/api3/tasks/<task_id>/files/?count=50&offset=0" \
    -u <token>: \
    -X GET
Request Parameters:

count: (Optional) Number of results to return. Default is 20.

offset: (Optional) Number of results to skip. Default is 0.

Example Success Response:
{
    "count": 20,
    "offset": 0,
    "total_count": 2,
    "objects": [
        {
            "id": 1,
            "name": "contract.pdf",
            "size": "0.45Mb"
        },
        {
            "id": 2,
            "name": "proposal.docx",
            "size": "0.12Mb"
        }
    ]
}
Base Request:

Method: GET

Authentication: Basic Authentication. Requires a valid <token> passed.

Rate Limits:

30 requests within 5 seconds

Error Responses:
401 Unauthorized

This error occurs when the <token> is missing, invalid, or the API access is disabled.

Possible errors: "not authenticated" or "token is disabled" or "Agency API is disabled"
404 Not Found

This error occurs if the task with the specified ID does not exist.
Possible errors: "object does not exist"
405 Method Not Allowed

This error occurs if an HTTP method other than GET is used.
Possible errors: "wrong method"
429 Too Many Requests

This error occurs when the client has sent too many requests in a given amount of time, leading to rate limiting by the server.

Possible errors: "too many requests"
500 Server Error

Possible errors: "Internal server error"