SmartMatchApp

Retrieve Client Suggestions

Retrieve a list of client suggestions.

This endpoint retrieves a list of client suggestions. Pagination is supported through the count and offset parameters.

Example Requests:

Retrieve suggestions for a client:

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

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

curl "https://<your-agency>.smartmatchapp.com/api3/clients/<client_id>/suggestions/?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.

Example Success Response:
{
    "objects": [
        {
            "matched_client_id": 248,
            "client_percent": 100,
            "match_percent": 100,
            "percent": 100
        },
        {
            "matched_client_id": 248,
            "client_percent": 100,
            "match_percent": 91,
            "percent": 95
        }
    ],
    "count": 20,
    "offset": 0,
    "total_count": 2
}
Base Request:

Method: GET

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

Rate Limits:

5 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 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 (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"