For AI agents: a documentation index is available at the root level at /llms.txt and /llms-full.txt. Append /llms.txt to any URL for a page-level index, or .md for the markdown version of any page.
Developer Tools
CommunityContact UsConsole
DocsAPI Reference
DocsAPI Reference
  • API Reference
      • GETGet Account
      • GETGet Account membership
      • GETGet Accounts for User
Logo
Developer Tools
CommunityContact UsConsole
API ReferenceAccounts

Get Account

GET
https://api.frame.io/v2/accounts/:account_id
GET
/v2/accounts/:account_id
1import requests
2
3url = "https://api.frame.io/v2/accounts/account_id"
4
5response = requests.get(url)
6
7print(response.json())
1{
2  "invoice_emails": [
3    "string"
4  ],
5  "city": "string",
6  "account_default_color": "string",
7  "company_name": "string",
8  "storage": 1,
9  "file_count": 1,
10  "owner": {
11    "digest_frequency": "string",
12    "image_32": "string",
13    "image_128": "string",
14    "from_google": true,
15    "mfa_enforced_at": "string",
16    "email": "string",
17    "name": "string",
18    "image_64": "string",
19    "timezone_value": "string",
20    "account_id": "string",
21    "updated_at": "string",
22    "image_256": "string",
23    "_type": "string",
24    "user_hash": "string",
25    "upload_url": "string",
26    "profile_image": "string",
27    "first_login_at": "string",
28    "joined_via": "string",
29    "id": "string",
30    "next_digest_date": "string",
31    "last_seen": "string",
32    "inserted_at": "string",
33    "roles": {
34      "admin": true,
35      "id": "string",
36      "sales": true,
37      "support": true
38    },
39    "user_default_color": "string"
40  },
41  "upload_url": "string",
42  "deleted_at": "2024-01-15T09:30:00Z",
43  "line1": "string",
44  "postal_code": "string",
45  "vat": "string",
46  "company_address": "string",
47  "lifetime_file_count": 1,
48  "state": "string",
49  "teams": [
50    {
51      "account_id": "string",
52      "disable_sbwm_internally": false,
53      "creator_id": "string",
54      "storage": 0,
55      "default_font_color": "string",
56      "access": "private",
57      "font_color": "string",
58      "user_role": {},
59      "file_count": 0,
60      "default_session_watermark_template": {
61        "account_id": "string",
62        "app_default": false,
63        "creator_id": "string",
64        "id": "string",
65        "name": "string",
66        "watermark_blocks": [
67          {
68            "alpha": 0.5,
69            "data_points": [
70              {
71                "order": 1,
72                "type": "email",
73                "value": "string"
74              }
75            ],
76            "font_size": "medium",
77            "name": "string",
78            "position": "top_left",
79            "position_reference_point": "top_left",
80            "position_x": 1,
81            "position_y": 1,
82            "scroll_text": "none",
83            "text_alignment": "left",
84            "text_color": "#FFFFFF",
85            "text_shadow": false
86          }
87        ]
88      },
89      "link": "string",
90      "asset_lifecycle_policy": 1,
91      "upload_url": "string",
92      "admin_only_actions": {
93        "lifecycle": false
94      },
95      "deleted_at": "2024-01-15T09:30:00Z",
96      "default_background_color": "string",
97      "storage_limit": 1,
98      "location": "string",
99      "name": "string",
100      "default_color": "string",
101      "slack_webhook": {},
102      "image_64": "string",
103      "archived_storage": 0,
104      "image_128": "string",
105      "solo": false,
106      "account": {
107        "invoice_emails": [
108          "string"
109        ],
110        "city": "string",
111        "account_default_color": "string",
112        "company_name": "string",
113        "storage": 1,
114        "file_count": 1,
115        "owner": {
116          "digest_frequency": "string",
117          "image_32": "string",
118          "image_128": "string",
119          "from_google": true,
120          "mfa_enforced_at": "string",
121          "email": "string",
122          "name": "string",
123          "image_64": "string",
124          "timezone_value": "string",
125          "account_id": "string",
126          "updated_at": "string",
127          "image_256": "string",
128          "_type": "string",
129          "user_hash": "string",
130          "upload_url": "string",
131          "profile_image": "string",
132          "first_login_at": "string",
133          "joined_via": "string",
134          "id": "string",
135          "next_digest_date": "string",
136          "last_seen": "string",
137          "inserted_at": "string",
138          "roles": {
139            "admin": true,
140            "id": "string",
141            "sales": true,
142            "support": true
143          },
144          "user_default_color": "string"
145        },
146        "upload_url": "string",
147        "deleted_at": "2024-01-15T09:30:00Z",
148        "line1": "string",
149        "postal_code": "string",
150        "vat": "string",
151        "company_address": "string",
152        "lifetime_file_count": 1,
153        "state": "string",
154        "teams": [
155          null
156        ],
157        "image_64": "string",
158        "archived_storage": 1,
159        "image_128": "string",
160        "owner_id": "string",
161        "user_count": 1,
162        "locked_at": "2024-01-15T09:30:00Z",
163        "image": "string",
164        "team_count": 1,
165        "collaborator_role_count": 1,
166        "billing_emails": "string",
167        "image_32": "string",
168        "unpaid_at": "2024-01-15T09:30:00Z",
169        "inserted_at": "2024-01-15T09:30:00Z",
170        "updated_at": "2024-01-15T09:30:00Z",
171        "project_count": 1,
172        "duration": 1,
173        "delinquent_at": "2024-01-15T09:30:00Z",
174        "collaborator_count": 1,
175        "plan": {
176          "archived_storage_limit": 1,
177          "autoscaling": true,
178          "available_features": {
179            "archival_storage": true,
180            "custom_branded_emails": true,
181            "custom_branded_presentations": true,
182            "reel_player": true,
183            "secure_sharing": true,
184            "session_based_watermarking": true,
185            "team_only_comments": true
186          },
187          "collaborator_limit": 1,
188          "cost": 1,
189          "default_plan": true,
190          "deleted_at": "2024-01-15T09:30:00Z",
191          "enterprise": true,
192          "file_limit": 1,
193          "id": "string",
194          "inserted_at": "2024-01-15T09:30:00Z",
195          "lifetime_file_limit": 1,
196          "member_limit": 1,
197          "name": "string",
198          "payment_method": "stripe",
199          "period": "monthly",
200          "project_limit": 1,
201          "storage_limit": 1,
202          "team_limit": 1,
203          "tier": "free",
204          "title": "string",
205          "updated_at": "2024-01-15T09:30:00Z",
206          "user_limit": 1,
207          "user_max": 1,
208          "version": 1
209        },
210        "watermark": {
211          "image": {
212            "alpha": 0.5,
213            "image": {
214              "bucket": "string",
215              "key": "string",
216              "type": "image/jpeg",
217              "uploaded": false
218            },
219            "position": "top_left"
220          },
221          "text": {
222            "alpha": 0.5,
223            "lines": [
224              "string"
225            ],
226            "position": "top"
227          }
228        },
229        "folder_count": 1,
230        "id": "string",
231        "display_name": "string",
232        "country": "string",
233        "subscription": {
234          "account_id": "string",
235          "archived_storage_limit": 1,
236          "balance": 1,
237          "cancellation_option": "string",
238          "cancellation_reason": "string",
239          "cancelled_at": "2024-01-15T09:30:00Z",
240          "deleted_at": "2024-01-15T09:30:00Z",
241          "id": "string",
242          "inserted_at": "2024-01-15T09:30:00Z",
243          "last_payment_at": "2024-01-15T09:30:00Z",
244          "member_limit": 1,
245          "next_bill_at": "2024-01-15T09:30:00Z",
246          "on_trial": true,
247          "plan": {
248            "archived_storage_limit": 1,
249            "autoscaling": true,
250            "available_features": {
251              "archival_storage": true,
252              "custom_branded_emails": true,
253              "custom_branded_presentations": true,
254              "reel_player": true,
255              "secure_sharing": true,
256              "session_based_watermarking": true,
257              "team_only_comments": true
258            },
259            "collaborator_limit": 1,
260            "cost": 1,
261            "default_plan": true,
262            "deleted_at": "2024-01-15T09:30:00Z",
263            "enterprise": true,
264            "file_limit": 1,
265            "id": "string",
266            "inserted_at": "2024-01-15T09:30:00Z",
267            "lifetime_file_limit": 1,
268            "member_limit": 1,
269            "name": "string",
270            "payment_method": "stripe",
271            "period": "monthly",
272            "project_limit": 1,
273            "storage_limit": 1,
274            "team_limit": 1,
275            "tier": "free",
276            "title": "string",
277            "updated_at": "2024-01-15T09:30:00Z",
278            "user_limit": 1,
279            "user_max": 1,
280            "version": 1
281          },
282          "plan_id": "string",
283          "promotion_expires_at": "2024-01-15T09:30:00Z",
284          "promotion_id": "string",
285          "requires_autoscaling": true,
286          "storage_limit": 1,
287          "subscription_end_at": "2024-01-15T09:30:00Z",
288          "total_archived_storage_limit": 1,
289          "total_lifetime_file_limit": 1,
290          "total_member_limit": 1,
291          "total_project_limit": 1,
292          "total_storage_limit": 1,
293          "total_user_limit": 1,
294          "updated_at": "2024-01-15T09:30:00Z",
295          "user_limit": 1
296        },
297        "account_members": [
298          {
299            "accepted_at": "2024-01-15T09:30:00Z",
300            "account_id": "string",
301            "declined_at": "2024-01-15T09:30:00Z",
302            "deleted_at": "2024-01-15T09:30:00Z",
303            "inserted_at": "2024-01-15T09:30:00Z",
304            "role": "admin",
305            "updated_at": "2024-01-15T09:30:00Z",
306            "user_id": "string"
307          }
308        ],
309        "frames": 1,
310        "member_count": 1,
311        "image_256": "string"
312      },
313      "image_32": "string",
314      "inserted_at": "2024-01-15T09:30:00Z",
315      "updated_at": "2024-01-15T09:30:00Z",
316      "project_count": 0,
317      "duration": 0,
318      "team_image": "string",
319      "collaborator_count": 0,
320      "bio": "string",
321      "color": "string",
322      "email_branding": {
323        "accent_color": "string",
324        "background_color": "string",
325        "image": {
326          "bucket": "string",
327          "key": "string",
328          "type": "image/jpeg",
329          "uploaded": false
330        }
331      },
332      "folder_count": 0,
333      "dark_theme": false,
334      "default_session_watermark_template_id": "string",
335      "session_watermark_templates": [
336        {
337          "account_id": "string",
338          "app_default": false,
339          "creator_id": "string",
340          "id": "string",
341          "name": "string",
342          "watermark_blocks": [
343            {
344              "alpha": 0.5,
345              "data_points": [
346                {
347                  "order": 1,
348                  "type": "email",
349                  "value": "string"
350                }
351              ],
352              "font_size": "medium",
353              "name": "string",
354              "position": "top_left",
355              "position_reference_point": "top_left",
356              "position_x": 1,
357              "position_y": 1,
358              "scroll_text": "none",
359              "text_alignment": "left",
360              "text_color": "#FFFFFF",
361              "text_shadow": false
362            }
363          ]
364        }
365      ],
366      "id": "string",
367      "member_limit": 1,
368      "frames": 0,
369      "member_count": 0,
370      "image_256": "string",
371      "background_color": "string"
372    }
373  ],
374  "image_64": "string",
375  "archived_storage": 1,
376  "image_128": "string",
377  "owner_id": "string",
378  "user_count": 1,
379  "locked_at": "2024-01-15T09:30:00Z",
380  "image": "string",
381  "team_count": 1,
382  "collaborator_role_count": 1,
383  "billing_emails": "string",
384  "image_32": "string",
385  "unpaid_at": "2024-01-15T09:30:00Z",
386  "inserted_at": "2024-01-15T09:30:00Z",
387  "updated_at": "2024-01-15T09:30:00Z",
388  "project_count": 1,
389  "duration": 1,
390  "delinquent_at": "2024-01-15T09:30:00Z",
391  "collaborator_count": 1,
392  "plan": {
393    "archived_storage_limit": 1,
394    "autoscaling": true,
395    "available_features": {
396      "archival_storage": true,
397      "custom_branded_emails": true,
398      "custom_branded_presentations": true,
399      "reel_player": true,
400      "secure_sharing": true,
401      "session_based_watermarking": true,
402      "team_only_comments": true
403    },
404    "collaborator_limit": 1,
405    "cost": 1,
406    "default_plan": true,
407    "deleted_at": "2024-01-15T09:30:00Z",
408    "enterprise": true,
409    "file_limit": 1,
410    "id": "string",
411    "inserted_at": "2024-01-15T09:30:00Z",
412    "lifetime_file_limit": 1,
413    "member_limit": 1,
414    "name": "string",
415    "payment_method": "stripe",
416    "period": "monthly",
417    "project_limit": 1,
418    "storage_limit": 1,
419    "team_limit": 1,
420    "tier": "free",
421    "title": "string",
422    "updated_at": "2024-01-15T09:30:00Z",
423    "user_limit": 1,
424    "user_max": 1,
425    "version": 1
426  },
427  "watermark": {
428    "image": {
429      "alpha": 0.5,
430      "image": {
431        "bucket": "string",
432        "key": "string",
433        "type": "image/jpeg",
434        "uploaded": false
435      },
436      "position": "top_left"
437    },
438    "text": {
439      "alpha": 0.5,
440      "lines": [
441        "string"
442      ],
443      "position": "top"
444    }
445  },
446  "folder_count": 1,
447  "id": "string",
448  "display_name": "string",
449  "country": "string",
450  "subscription": {
451    "account_id": "string",
452    "archived_storage_limit": 1,
453    "balance": 1,
454    "cancellation_option": "string",
455    "cancellation_reason": "string",
456    "cancelled_at": "2024-01-15T09:30:00Z",
457    "deleted_at": "2024-01-15T09:30:00Z",
458    "id": "string",
459    "inserted_at": "2024-01-15T09:30:00Z",
460    "last_payment_at": "2024-01-15T09:30:00Z",
461    "member_limit": 1,
462    "next_bill_at": "2024-01-15T09:30:00Z",
463    "on_trial": true,
464    "plan": {
465      "archived_storage_limit": 1,
466      "autoscaling": true,
467      "available_features": {
468        "archival_storage": true,
469        "custom_branded_emails": true,
470        "custom_branded_presentations": true,
471        "reel_player": true,
472        "secure_sharing": true,
473        "session_based_watermarking": true,
474        "team_only_comments": true
475      },
476      "collaborator_limit": 1,
477      "cost": 1,
478      "default_plan": true,
479      "deleted_at": "2024-01-15T09:30:00Z",
480      "enterprise": true,
481      "file_limit": 1,
482      "id": "string",
483      "inserted_at": "2024-01-15T09:30:00Z",
484      "lifetime_file_limit": 1,
485      "member_limit": 1,
486      "name": "string",
487      "payment_method": "stripe",
488      "period": "monthly",
489      "project_limit": 1,
490      "storage_limit": 1,
491      "team_limit": 1,
492      "tier": "free",
493      "title": "string",
494      "updated_at": "2024-01-15T09:30:00Z",
495      "user_limit": 1,
496      "user_max": 1,
497      "version": 1
498    },
499    "plan_id": "string",
500    "promotion_expires_at": "2024-01-15T09:30:00Z",
501    "promotion_id": "string",
502    "requires_autoscaling": true,
503    "storage_limit": 1,
504    "subscription_end_at": "2024-01-15T09:30:00Z",
505    "total_archived_storage_limit": 1,
506    "total_lifetime_file_limit": 1,
507    "total_member_limit": 1,
508    "total_project_limit": 1,
509    "total_storage_limit": 1,
510    "total_user_limit": 1,
511    "updated_at": "2024-01-15T09:30:00Z",
512    "user_limit": 1
513  },
514  "account_members": [
515    {
516      "accepted_at": "2024-01-15T09:30:00Z",
517      "account_id": "string",
518      "declined_at": "2024-01-15T09:30:00Z",
519      "deleted_at": "2024-01-15T09:30:00Z",
520      "inserted_at": "2024-01-15T09:30:00Z",
521      "role": "admin",
522      "updated_at": "2024-01-15T09:30:00Z",
523      "user_id": "string"
524    }
525  ],
526  "frames": 1,
527  "member_count": 1,
528  "image_256": "string"
529}
Fetch a particular account by ID
Was this page helpful?

Get Account membership

Next

Path parameters

account_idstringRequired

Response

Account success response
invoice_emailslist of strings
citystring
account_default_colorstring
company_namestring
storageinteger
file_countinteger
ownerobject
User model
upload_urlstring
deleted_atstringformat: "date-time"
line1string
postal_codestring
vatstring
company_addressstring
lifetime_file_countinteger
statestring
teamslist of objects
image_64string
archived_storageinteger
image_128string
owner_idstringformat: "uuid"
user_countinteger
locked_atstringformat: "date-time"
imagestring
team_countinteger
collaborator_role_countinteger
billing_emailsstring
image_32string
unpaid_atstringformat: "date-time"
inserted_atstringformat: "date-time"
updated_atstringformat: "date-time"
project_countinteger
durationinteger
delinquent_atstringformat: "date-time"
collaborator_countinteger
planobject
watermarkobject
folder_countinteger
idstringformat: "uuid"
display_namestring
countrystring
subscriptionobject
account_memberslist of objects
framesinteger
member_countinteger
image_256string

Errors

401
Unauthorized Error
404
Not Found Error