V1Folders
Get Folder
Returns the specified folder with information on the sequences contained within, along with all of that folder’s sequences. The complete sequence information will be return, including the title, body and any other attributes that may have been configured for that sequence.
Returns the specified folder with information on the sequences contained within, along with all of that folder’s sequences. The complete sequence information will be return, including the title, body and any other attributes that may have been configured for that sequence.
Authorization
access_token Authorization<token>
In: header
Path Parameters
id*string
folder ID
Response Body
application/json
application/json
curl -X GET "https://example.com/api/v1/folders/string"{ "status": "string", "data": { "id": "string", "title": "string", "owner_id": "string", "owner_team_id": "string", "total_sequences": 0, "total_folders": 0, "sequences": [ { "title": "string", "body": null, "style": null, "id": "string", "embed": "embed_disabled", "shortlink": null, "thumbnail": null, "visibility": "visibility_public", "owner_id": "string", "team_owner_id": "string", "created_at": "string", "updated_at": "string", "parent_folders": [ { "id": "string", "title": "string", "total_sequences": 0, "total_folders": 0, "owner_id": "string", "owner_team_id": "string", "created_at": "string", "updated_at": "string" } ], "default_team": { "id": "string", "name": "string", "description": "string", "owner": { "id": "abc123xyz", "first_name": "John", "last_name": "Doe", "email": "john.doe@example.com", "avatar": "https://lh3.googleusercontent.com/a/AAcHTtcLT_gPCblFHL0QKonMt4822u5qrtlsvvrm0aAC1LszcPg=s288-c-no", "created_at": "06/29/2023 21:14:57", "updated_at": "06/29/2023 21:14:57" }, "created_at": "string", "updated_at": "string", "active": true, "total_team_members": 1, "active_team_members": 1, "inactive_team_members": 1, "folder_size": 0, "user_permissions": {}, "team_members": { "status": "ok", "data": { "pagination": { "total_pages": 0, "current_page": 0 }, "list": [ { "id": "string", "invitation_status": "string", "invitation_email": "string", "invitation_accepted_at": "string", "active": true, "created_at": "string", "updated_at": "string", "permission_role": "string", "user": { "id": "abc123xyz", "first_name": "John", "last_name": "Doe", "email": "john.doe@example.com", "avatar": "https://lh3.googleusercontent.com/a/AAcHTtcLT_gPCblFHL0QKonMt4822u5qrtlsvvrm0aAC1LszcPg=s288-c-no", "created_at": "06/29/2023 21:14:57", "updated_at": "06/29/2023 21:14:57" }, "team_roles": [ { "id": "string", "team_id": "string", "name": "QA", "description": "The QA role involves rigorously testing and identifying bugs in software to ensure its overall quality and reliability.", "created_at": "string", "updated_at": "string" } ] } ] } } }, "default_team_roles_assignments": [ { "id": "string", "team_member": { "id": "string", "invitation_status": "string", "invitation_email": "string", "invitation_accepted_at": "string", "active": true, "created_at": "string", "updated_at": "string", "permission_role": "string", "user": { "id": "abc123xyz", "first_name": "John", "last_name": "Doe", "email": "john.doe@example.com", "avatar": "https://lh3.googleusercontent.com/a/AAcHTtcLT_gPCblFHL0QKonMt4822u5qrtlsvvrm0aAC1LszcPg=s288-c-no", "created_at": "06/29/2023 21:14:57", "updated_at": "06/29/2023 21:14:57" }, "team_roles": [ { "id": "string", "team_id": "string", "name": "QA", "description": "The QA role involves rigorously testing and identifying bugs in software to ensure its overall quality and reliability.", "created_at": "string", "updated_at": "string" } ] }, "team_role": { "id": "string", "team_id": "string", "name": "QA", "description": "The QA role involves rigorously testing and identifying bugs in software to ensure its overall quality and reliability.", "created_at": "string", "updated_at": "string" } } ], "collaborators": [ { "id": "abc123xyz", "first_name": "John", "last_name": "Doe", "email": "john.doe@example.com", "avatar": "https://lh3.googleusercontent.com/a/AAcHTtcLT_gPCblFHL0QKonMt4822u5qrtlsvvrm0aAC1LszcPg=s288-c-no", "created_at": "06/29/2023 21:14:57", "updated_at": "06/29/2023 21:14:57" } ] } ], "parent_folders": [ { "id": "string", "title": "string", "total_sequences": 0, "total_folders": 0, "owner_id": "string", "owner_team_id": "string", "created_at": "string", "updated_at": "string" } ], "folders": [ { "id": "string", "title": "string", "total_sequences": 0, "total_folders": 0, "owner_id": "string", "owner_team_id": "string", "created_at": "string", "updated_at": "string" } ], "created_at": "string", "updated_at": "string" }}