SmartMatchApp

Retrieve Folder Details

Retrieve the details of a specific folder associated with a client.

This endpoint retrieves the details of a specific folder associated with a client, including the folder's name and its parent folder if it has one.

Example Request:
curl "https://<your-agency>.smartmatchapp.com/api3/clients/<client_id>/folders/<folder_id>" \
    -u <token>: \
    -X GET
Example Success Response:
{
    "id": 1,
    "name": "Folder 1",
    "parent": {
        "id": 2,
        "name": "Folder 2"
    }
}

If the folder does not have a parent, the parent key will not be present in the response.

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 or the folder 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"