SmartMatchApp

Retrieve Client Lists

Retrieve a list of all lists associated with the specified client.

This endpoint retrieves a list of all lists associated with the specified client, including each list's ID and name.

Example Request:
curl "https://<your-agency>.smartmatchapp.com/api3/clients/<client_id>/lists/" \
    -u <token>: \
    -X GET
Example Success Response:
[
    {
        "id": 1,
        "name": "List One"
    },
    {
        "id": 2,
        "name": "List Two"
    }
]
Base Request:

Method: GET

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

Rate Limits:

10 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"