Get Account

GET

https://api.frame.io/v2/accounts/:account_id

GET

/v2/accounts/:account_id

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

Fetch a particular account by ID

Authentication

AuthorizationBearer

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

Path parameters

account_idstringRequiredformat: "uuid"

Account ID

Response

Account success response

invoice_emailslist of stringsOptional

citystringOptional

account_default_colorstringOptional

company_namestringOptional

storageintegerOptional

file_countintegerOptional

ownerobjectOptional

User model

upload_urlstringOptional

deleted_atstringOptionalformat: "date-time"

line1stringOptional

postal_codestringOptional

vatstringOptional

company_addressstringOptional

lifetime_file_countintegerOptional

statestringOptional

teamslist of objectsOptional

image_64stringOptional

archived_storageintegerOptional

image_128stringOptional

owner_idstringOptionalformat: "uuid"

user_countintegerOptional

locked_atstringOptionalformat: "date-time"

imagestringOptional

team_countintegerOptional

collaborator_role_countintegerOptional

billing_emailsstringOptional

image_32stringOptional

unpaid_atstringOptionalformat: "date-time"

inserted_atstringOptionalformat: "date-time"

updated_atstringOptionalformat: "date-time"

project_countintegerOptional

durationintegerOptional

delinquent_atstringOptionalformat: "date-time"

collaborator_countintegerOptional

planobjectOptional

watermarkobjectOptional

folder_countintegerOptional

idstringOptionalformat: "uuid"

display_namestringOptional

countrystringOptional

subscriptionobjectOptional

account_memberslist of objectsOptional

framesintegerOptional

member_countintegerOptional

image_256stringOptional

Errors

401

Unauthorized Error

404

Not Found Error