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
HomeAPI ReferenceDocsChangelog
HomeAPI ReferenceDocsChangelog
  • API Reference
      • GETList account user roles
Logo
Developer Tools
CommunityContact UsConsole
API ReferenceAccount Permissions

List account user roles

GET
https://api.frame.io/v4/accounts/:account_id/users
GET
/v4/accounts/:account_id/users
1from frameio import Frameio
2
3client = Frameio(
4 token="YOUR_TOKEN_HERE",
5)
6
7client.account_permissions.index(
8 account_id="7798b4b9-bb83-4a23-b606-1f0805712dd3",
9)
1{
2 "data": [
3 {
4 "role": "admin",
5 "user": {
6 "active": true,
7 "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",
8 "email": "user_email@example.com",
9 "id": "196C1A5666BF4EB00A49411B@176719f5667c82b4494214.e",
10 "name": "Jon Doe"
11 }
12 }
13 ],
14 "links": {
15 "next": "/v4/accounts/1234/workspaces/5678/projects?after=g3QAAAACZAACaWRtAAAAJGFiMmNiY2QzLWFkODQtNDQwMC05YTRkLWE1ZDRkMGE4ZTIxM2QABG5hbWVtAAAACVByb2plY3QgMg=="
16 },
17 "total_count": 10
18}

List user roles for a given account.
Rate Limits: 100 calls per 1.00 minute(s) per account_user

Was this page helpful?

List accounts

Next

Authentication

AuthorizationBearer

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

Path parameters

account_idstringRequiredformat: "uuid"
A UUID String

Query parameters

include_deactivatedbooleanOptional
Supports including deactivated users in the response. Default is false.
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

OK
datalist of objects
Account User Roles
linksobject
Links to paginated data
total_countinteger or null
Total count

Errors

400
Bad Request Error
401
Unauthorized Error
403
Forbidden Error
404
Not Found Error
422
Unprocessable Entity Error
429
Too Many Requests Error