Returns basic information on the workspace. Does not include deleted collaborators and only include outstanding invites.
Collaborators
Get workspace collaborators
get
https://api.airtable.com/v0/meta/workspaces/{workspaceId}
Authentication | Personal access token, OAuth integration |
Scope | workspacesAndBases:read |
User role | Workspace read-only |
Billing plans | Enterprise (pre-2023.08 legacy plan), Enterprise Scale |
optional< array of ("collaborators" | "inviteLinks") > If specified, collaborators or inviteLinks key will be included in the response object. Otherwise they will be left out. |
string | |||||
string A date timestamp in the ISO format, eg:"2018-01-01T00:00:00.000Z" | |||||
string | |||||
object Sharing restrictions settings enforced on the workspace.
| |||||
optional< object > This property is deprecated Please use individualCollaborators and groupCollaborators instead.
| |||||
optional< object > Groups whose members are collaborating on this workspace. Note: Group cannot be owner of a workspace.
| |||||
optional< object > Individual users that are explicitly added as collaborators on the workspace. Does not include users that only have access via membership in a group that has been added as a collaborator.
| |||||
array of strings | |||||
optional< object >
|
Request (example)
Copy
$curl "https://api.airtable.com/v0/meta/workspaces/{workspaceId}" \-H "Authorization: Bearer YOUR_TOKEN"
200 – Response (example)
{"baseIds": ["appLkNDICXNqxSDhG","appSW9R5uCNmRmfl6"],"collaborators": {"baseCollaborators": [{"baseId": "appLkNDICXNqxSDhG","createdTime": "2019-01-03T12:33:12.421Z","email": "foo@bam.com","grantedByUserId": "usrL2PNC5o3H4lBEi","permissionLevel": "create","userId": "usrsOEchC9xuwRgKk"}],"workspaceCollaborators": [{"createdTime": "2019-01-03T12:33:12.421Z","email": "foo@bar.com","grantedByUserId": "usrL2PNC5o3H4lBEi","permissionLevel": "owner","userId": "usrL2PNC5o3H4lBEi"}]},"createdTime": "2019-01-03T12:33:12.421Z","groupCollaborators": {"baseCollaborators": [{"baseId": "appLkNDICXNqxSDhG","createdTime": "2019-01-03T12:33:12.421Z","grantedByUserId": "usrL2PNC5o3H4lBEi","groupId": "ugpR8ZT9KtIgp8Bh3","name": "group 2","permissionLevel": "create"}],"workspaceCollaborators": [{"createdTime": "2019-01-03T12:33:12.421Z","grantedByUserId": "usrL2PNC5o3H4lBEi","groupId": "ugp1mKGb3KXUyQfOZ","name": "group 1","permissionLevel": "edit"}]},"id": "wspmhESAta6clCCwF","individualCollaborators": {"baseCollaborators": [{"baseId": "appLkNDICXNqxSDhG","createdTime": "2019-01-03T12:33:12.421Z","email": "foo@bam.com","grantedByUserId": "usrL2PNC5o3H4lBEi","permissionLevel": "create","userId": "usrsOEchC9xuwRgKk"}],"workspaceCollaborators": [{"createdTime": "2019-01-03T12:33:12.421Z","email": "foo@bar.com","grantedByUserId": "usrL2PNC5o3H4lBEi","permissionLevel": "owner","userId": "usrL2PNC5o3H4lBEi"}]},"inviteLinks": {"baseInviteLinks": [{"baseId": "appSW9R5uCNmRmfl6","createdTime": "2019-01-03T12:33:12.421Z","id": "invJiqaXmPqq6Ec87","invitedEmail": null,"permissionLevel": "read","referredByUserId": "usrsOEchC9xuwRgKk","restrictedToEmailDomains": [],"type": "multiUse"}],"workspaceInviteLinks": [{"createdTime": "2019-01-03T12:33:12.421Z","id": "invJiqaXmPqq6Ec87","invitedEmail": "bam@bam.com","permissionLevel": "owner","referredByUserId": "usrL2PNC5o3H4lBEi","restrictedToEmailDomains": ["foobar.com"],"type": "singleUse"}]},"name": "my first workspace","workspaceRestrictions": {"inviteCreationRestriction": "onlyOwners","shareCreationRestriction": "unrestricted"}}