List comments | Frame.io API Documentation

1 from frameio import Frameio 2 3 client = Frameio( 4 base_url="https://api.frame.io", 5 token="YOUR_TOKEN_HERE" 6 ) 7 8 client.comments.index( 9 account_id="88c8ffe8-2450-47ef-bd85-2549e080a62f", 10 file_id="a96b29a6-4e65-4101-8616-b44e527d84b1" 11 )

1 { 2 "data": [ 3 { 4 "annotation": "annotation", 5 "completed_at": {}, 6 "completer_id": {}, 7 "created_at": "2024-02-02T21:19:24.828948Z", 8 "file_id": "4ae08df1-b419-4897-aba5-560198a18237", 9 "id": "52a1032a-63a3-44a3-9ce5-f904fc158e23", 10 "page": 1, 11 "text": "This is great!", 12 "text_edited_at": "2024-02-02T21:19:24.828948Z", 13 "timestamp": 123, 14 "updated_at": "2024-02-02T21:19:24.828948Z", 15 "owner": { 16 "active": true, 17 "avatar_url": "https://assets.frame.io/uploads/cd58cb8e-24b3-4448-8d0f-9532fcd04d11/original.png?response-content-disposition=attachment%3B+filename%3D%22foo.png&Expires=1729857600&Signature=L09h0pi82dCrMYjr9lMHBragByWYh1&Key-Pair-Id=KKI497NESTHMN", 18 "email": "user_email@example.com", 19 "id": "196C1A5666BF4EB00A49411B@176719f5667c82b4494214.e", 20 "name": "Jon Doe" 21 }, 22 "replies": [] 23 }, 24 { 25 "annotation": "annotation", 26 "completed_at": {}, 27 "completer_id": {}, 28 "created_at": "2024-02-02T21:19:24.828948Z", 29 "file_id": "4ae08df1-b419-4897-aba5-560198a18237", 30 "id": "52a1032a-63a3-44a3-9ce5-f904fc158e23", 31 "page": 1, 32 "text": "This is great!", 33 "text_edited_at": "2024-02-02T21:19:24.828948Z", 34 "timestamp": 123, 35 "updated_at": "2024-02-02T21:19:24.828948Z", 36 "owner": { 37 "active": true, 38 "avatar_url": "https://assets.frame.io/uploads/cd58cb8e-24b3-4448-8d0f-9532fcd04d11/original.png?response-content-disposition=attachment%3B+filename%3D%22foo.png&Expires=1729857600&Signature=L09h0pi82dCrMYjr9lMHBragByWYh1&Key-Pair-Id=KKI497NESTHMN", 39 "email": "user_email@example.com", 40 "id": "196C1A5666BF4EB00A49411B@176719f5667c82b4494214.e", 41 "name": "Jon Doe" 42 }, 43 "replies": [ 44 { 45 "annotation": "annotation", 46 "completed_at": "2024-01-15T09:30:00Z", 47 "completer_id": "string", 48 "created_at": "2024-02-02T21:19:24.828948Z", 49 "file_id": "4ae08df1-b419-4897-aba5-560198a18237", 50 "id": "52a1032a-63a3-44a3-9ce5-f904fc158e23", 51 "page": 1, 52 "text": "This is great!", 53 "text_edited_at": "2024-02-02T21:19:24.828948Z", 54 "timestamp": 123, 55 "updated_at": "2024-02-02T21:19:24.828948Z" 56 } 57 ] 58 } 59 ], 60 "links": { 61 "next": "/v4/accounts/1234/workspaces/5678/projects?after=g3QAAAACZAACaWRtAAAAJGFiMmNiY2QzLWFkODQtNDQwMC05YTRkLWE1ZDRkMGE4ZTIxM2QABG5hbWVtAAAACVByb2plY3QgMg==" 62 }, 63 "total_count": 10 64 }

List comments on a given asset.
Rate Limits: 100 calls per 1.00 minute(s) per account_user

Authentication

AuthorizationBearer

Bearer authentication of the form Bearer <token>, where token is your auth token.

Path Parameters

account_idstringRequiredformat: "uuid"

A UUID String

file_idstringRequiredformat: "uuid"

A UUID String

Query Parameters

includeenumOptional

Include query parameter for comments

Allowed values:

afterstringOptional

Opaque Cursor query param for requests returning paginated results.

NOTE: this value is auto-generated and included as part of links from a previous response. It is not intended to be human readable.

page_sizeintegerOptional1-100Defaults to 50

Page size query param for requests

include_total_countbooleanOptionalDefaults to false

Page query param to include the count of all entities

Response

datalist of objects

Comments

linksobject

Links to paginated data

total_countinteger or null

Total count

Authentication

Path Parameters

Query Parameters

Response

Errors