Parameters
#organizationstring
Organization name or ID. Omit to list your organizations.
Returns
#dataobject[] | objectAlways present
Your organizations and roles, or one organization's membership, teams and settings.
Show 2 attributesHide attributes
alternative-1object[]
An organization you belong to and your permissions in it.
Show 1 attributeHide attributes
itemsobject
An organization you belong to and your permissions in it.
Show 8 attributesHide attributes
display_namestring
Its display name, when different from its command name. May be omitted.
grant_scopestring
Resources reached by the additional command grants. May be omitted.
grantsstring[]
Commands granted beyond your role. May be omitted.
idstringAlways present
Organization ID.
namestringAlways present
Organization name accepted by commands.
picturestring
Organization's picture URL. May be omitted.
rolestringAlways present
Your role in this organization.
withholdsstring[]
Commands withheld even though your role would otherwise allow them. May be omitted.
alternative-2object
An organization's settings, members, teams and your permissions.
Show 15 attributesHide attributes
closing_atstring (date-time)
When a scheduled organization closure takes effect. May be omitted.
computer_sharingstringAlways present
Organization's policy for sharing Computers.
computersintegerAlways present
Organization's Computer count.
grant_scopestring
Resources reached by additional command grants. May be omitted.
grantsstring[]
Commands granted beyond your role. May be omitted.
idstringAlways present
Organization ID.
invitationsobject[]
Pending invitations, visible to the billing owner and admins. May be omitted.
Show 1 attributeHide attributes
itemsobject
An unanswered invitation sent by the organization or one of its teams.
Show 11 attributesHide attributes
emailstringAlways present
Invited email, or user ID when invited by ID without email.
expires_atstring (date-time)Always present
When the invitation expires.
grant_scopestring
Resources reached by the offered grants. May be omitted.
grantsstring[]
Additional commands offered. May be omitted.
idstringAlways present
Invitation ID.
invited_bystringAlways present
Who sent the invitation.
rolestringAlways present
Offered organization role.
teamstring
Team sending a team invitation. May be omitted.
team_rolestring
Offered team role. May be omitted.
teamsstring[]
Teams included in the invitation. May be omitted.
withholdsstring[]
Commands withheld from the offered role. May be omitted.
membersobject[] | nullAlways present
Organization's members and permissions.
Show 1 attributeHide attributes
itemsobject
An organization member and their permissions.
Show 9 attributesHide attributes
emailstring | nullAlways present
Their email address, or null without one.
grant_scopestring
Resources reached by additional command grants. May be omitted.
grantsstring[]
Commands granted beyond the role. May be omitted.
namestring
Their saved display name, when available. May be omitted.
picturestring
Their profile picture URL. May be omitted.
rolestringAlways present
Their organization role.
teamsstring[] | nullAlways present
Teams this person belongs to.
user_idstringAlways present
Member's user ID.
withholdsstring[]
Commands withheld from the role. May be omitted.
namestringAlways present
Organization's command name.
outsider_invitationsstringAlways present
Who can invite outsiders:
team-admins or admins-only.picturestring
Organization's picture URL. May be omitted.
rolestringAlways present
Your organization role.
teamsobject[] | nullAlways present
Organization's teams.
Show 1 attributeHide attributes
itemsobject
An organization team, its members, owned Computers and shared access.
Show 8 attributesHide attributes
computersstring[] | nullAlways present
Computers owned by the team.
full_namestringAlways present
Team name qualified by its organization.
idstringAlways present
Team ID.
member_accessstringAlways present
Access team members receive to Computers the team owns.
membersobject[] | nullAlways present
Team's members and their team roles.
Show 1 attributeHide attributes
itemsobject
A person's membership in an organization team.
Show 5 attributesHide attributes
emailstring | nullAlways present
Their email address, or null without one.
namestring
Their display name, when set. May be omitted.
picturestring
Their profile picture URL. May be omitted.
rolestringAlways present
Their role within this team.
user_idstringAlways present
Person's user ID.
namestringAlways present
Team's name within its organization.
poolsobject[] | nullAlways present
Pools shared with the team by other accounts.
Show 1 attributeHide attributes
itemsobject
A pool another account shares with the team.
Show 5 attributesHide attributes
accountstringAlways present
Account providing the pool.
commandsstring[]
Additional commands the share grants. May be omitted.
poolstringAlways present
Shared pool's name.
pool_idstringAlways present
Shared pool's ID.
rolestringAlways present
Pool share's role.
withheldstring[]
Parts your permissions do not allow you to read. May be omitted.
withholdsstring[]
Commands withheld from your role. May be omitted.
Errors
#| Code | Status | What happened |
|---|---|---|
| invalid | 400 | An input is missing or invalid. |
| unauthenticated | 401 | The credential is missing, invalid, expired or revoked. |
| denied | 403 | The caller lacks permission for this action. |
| not_found | 404 | The resource is absent or inaccessible to this caller. |
| conflict | 409 | The request conflicts with the current resource state or an earlier request. |
| over_capacity | 409 | The request exceeds a resource or credential allowance. |
| access_list_full | 409 | The change would exceed the access-list allowance. |
| rate_limited | 429 | The caller's request rate exceeds its limit. |
| busy | 429 | Too much work is in progress to accept this request. |
| unknown | 503 | The outcome is unconfirmed; a change may have happened. |
| unavailable | 503 | The service or requested feature is unavailable. |
Notes
#- API key permission:
organization view.