Folders
Get folder ID by folder name
OpenAPI specificationGET
/api/v1/folders/by-name/{name}Authentication
x-api-key
Request
curl --globoff --request GET \
--url 'https://api.example.com/api/v1/folders/by-name/%3Cname%3E' \
--header 'x-api-key: <API_KEY>'Replace credential and <field> placeholders with your own values. URL placeholders appear as %3Cfield%3E. Review the example values before sending your request.
Replace https://api.example.com with the API server URL.
Parameters
namepath · string · requiredFolder name
parentFolderIdquery · stringParent folder ID for accurate matching (optional)
Responses
200Folder ID retrieved successfully
{
"type": "object",
"properties": {
"folderId": {
"type": "string",
"description": "Folder ID"
}
}
}