Folder Tree
This endpoint retrieves the hierarchical structure (tree) of folders associated with a specific client.
Example Request:
curl "https://<your-agency>.smartmatchapp.com/api3/clients/<client_id>/folders/tree/" \
-u <token>: \
-X GET
Example Success Response:
{
"objects": [
{
"id": 1,
"name": "Folder 1",
"folders": [
{
"id": 2,
"name": "Folder 2",
"folders": [
{
"id": 3,
"name": "Folders 3"
}
]
}
]
},
{
"id": 4,
"name": "Folder 4"
}
]
}
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 with the specified ID does not exist. |
| 405 | Method Not Allowed |
This error occurs if an HTTP method other than GET is used (e.g., POST or DELETE). |
| 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" |