List folders with the Vimeo API
Lists the folders of the connected user, with uri, name, link, dates and the number of videos in metadata.connections.videos.total. The id of a folder is the number at the end of its uri. Pagination by page: the list ends when paging.next is null.
- Identifier
- vimeo_list_folders
The request
POST https://connect.reportei.com/api/tools/vimeo_list_folders/execute
Authorization: Bearer <merchant token>
x-customer-token: <customer token>
Content-Type: application/json
Accept: application/json
{
"customer_toolkit": "<connection UUID>",
"arguments": {
"query": "<query>"
}
}Your system sends your customer's connection id and the tool arguments. The headers are the same as the rest of the Connect API: your product's token and your customer's token.
Parameters
| Parameter | Type | Required | Description |
|---|---|---|---|
| query | string | No | Text searched in the names of the folders. |
| sort | string | No | Order of the folders.Values: date, default, modified_time, name |
| direction | string | No | Direction of the order.Values: asc, desc |
| page | integer | No | Page to return, starting at 1. |
| per_page | integer | No | Folders per page, up to 100. The default is 25. |
Supported connections
Your customer connects their Vimeo account once, with one of the modes below. The same connection serves every tool of the toolkit.
OAuth with your product's app
You register your product's OAuth app once, with POST /api/merchants/credentials/vimeo, and your customer authorizes the account on a consent screen. Connect renews the token when it is about to expire.
The response
On success, Connect preserves the app's response status and body. HTTP errors returned by the app use the {error, api_error} envelope; authentication or validation can fail before execution. The X-Toolkit-Execution-Id header identifies the recorded execution, available at GET /api/tools/executions/{uuid}.
Ready for AI agents
This tool's input is a JSON Schema, available at GET /api/tools/vimeo_list_folders. It becomes your agent's tool definition with no conversion.
Other Vimeo tools
- List videosGETLists the videos the connected user uploaded, with uri, name, description, link, duration, privacy, parent_folder, tags, embed code and stats.plays, the play count. The id of a video is the number at the end of its uri. Pagination by page: the list ends when paging.next is null. Send fields to get a smaller answer and twice the rate limit.
- Get videoGETReturns one video: name, description, link, duration, dimensions, privacy, status, parent_folder, tags, embed code, thumbnails and stats.plays, the play count. Send fields to get a smaller answer and twice the rate limit.
- Update videoPATCHUpdates the title, description, privacy or license of a video of the connected user and returns it. Fields left out keep their value. Some privacy options, like password and team, depend on the plan of the account.
- Create folderPOSTCreates a folder for the connected user and returns it with its uri. Without parent_folder_uri it is a top-level folder; folders nest up to 10 levels.
- Update folderPATCHRenames a folder of the connected user and returns it.
- List folder videosGETLists the videos of a folder, with uri, name, description, link, duration, privacy, tags and stats.plays, the play count. Pagination by page: the list ends when paging.next is null. Send fields to get a smaller answer and twice the rate limit.
- Move video to folderPUTPuts a video in a folder of the connected user, who must own the folder. Answers 204 with no body when it works.
- List video commentsGETLists the comments of a video, with uri, text, author, date and the number of replies in metadata.connections.replies.total. The id of a comment is the number at the end of its uri. Pagination by page: the list ends when paging.next is null.
Toolkits in the same category
See all 100 toolkitsSee Connect applied to your product.
Try it for 15 days with no card, or walk our team through your use case.
