SmartMatchApp

Retrieve Client Details

Retrieve the details of a specific client.

This endpoint retrieves the details of a specified client, including basic information such as whether the client is archived or submitted, as well as the client type.

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

client_id: The ID of the client whose details you wish to retrieve. This field is required and must correspond to an existing client.

Example Success Response:
{
    "id": 1,
    "is_archived": false,
    "is_submitted": false,
    "created": "2022-01-01T10:00:00Z",
    "stype": {
        "id": 5,
        "name": "Company"
    },
    "assigned_users": [
        {
            "id": 1,
            "name": "John Doe",
            "email": "john@gmail.com"
        }
    ]
}
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 client with the specified ID does not exist.
Possible errors: "client not found"
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"
Available Fields:

The field ids, labels, types, and available values below are generic samples. Every agency defines its own custom fields, so your agency's own live list appears in its private copy of these API docs.

Title Name Type
id Integer Number
Archived is_archived Yes/No
Submitted is_submitted Yes/No
Created Date created DateTime
Type stype
Show Values
  • 1: Example Client Type
Assigned To assigned_users Staff members are specific to each agency; your agency's own copy of these docs lists them.