Folders API | Hitchhikers Platform
Overview
The Folders endpoint allows you to retrieve a list of all entity folders you have in the Yext platform. This will include the total folder count, as well as the folder ID and folder name.
Use Cases
- View a list of all entity folders
- Fetch the IDs for your folders so you can add entities to folders
Reference Docs
Guides
Folders: List
Returns a list of Location Folders in an Account.
path Parameters
| accountId required | string |
query Parameters
| offset | integer Default: 0 Number of results to skip. Used to page through results.
Cannot be used together with |
| limit | integer <= 1000 Default: 100 Number of results to return. |
| v required | string A date in |
Responses
Response samples
- 200
- default
Content type
application/json
{- "meta": {
- "uuid": "4f72b877-e2d0-4de4-9324-b9cf2c03e1a0"
}, - "response": {
- "count": 0,
- "folders": [
- {
- "id": "string",
- "parentId": "string",
- "name": "string"
}
]
}
}