SmartMatchApp

Retrieve Client Photos

Retrieve a list of photos from a specific client photo gallery, optionally paginated.

This endpoint retrieves a list of photos associated with a specific client. Pagination is supported through the count and offset parameters.

Example Requests:

Retrieve all photos for a client:

curl "https://<your-agency>.smartmatchapp.com/api3/clients/<client_id>/photos/" \
    -u <token>: \
    -X GET

Retrieve photos with pagination (e.g., 50 photos, starting from the 10th):

curl "https://<your-agency>.smartmatchapp.com/api3/clients/<client_id>/photos/?count=50&offset=10" \
    -u <token>: \
    -X GET
Request Parameters:

count: (Optional) The number of results to display in the response. The default is 20.

offset: (Optional) The offset from the beginning of the list. This allows you to paginate through the results.

Note: count and offset in the response echo the values you requested, not the size of the returned page. The last page can contain fewer than count items — compare offset plus the length of objects against total_count to detect the end of the list.

Example Success Response:
{
    "count": 20,
    "offset": 0,
    "total_count": 2,
    "objects": [
        {
            "id": 1,
            "name": "image_1.jpg",
            "size": "0.02Mb",
            "created_date": "2025-06-10T14:24:30.502Z",
            "created_user_name": "User 1",
            "created_user_id": 1,
            "download_url": "https://<your-agency>.smartmatchapp.com/download/<key>/<agency>/"
        },
        {
            "id": 2,
            "name": "image_2.jpg",
            "size": "0.02Mb",
            "created_date": "2025-06-10T14:31:30.502Z",
            "created_user_name": "User 2",
            "created_user_id": 2,
            "download_url": "https://<your-agency>.smartmatchapp.com/download/<key>/<agency>/"
        }
    ]
}
Base Request:

Method: GET

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

Rate Limits:

30 requests within 10 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 client 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 (e.g., POST or PUT).
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"