Organizations

Manage organizations, users, roles, invitations, and preferences.

Get Organization

get
Authorizations
AuthorizationstringRequired

Personal Access Token.

Path parameters
organization_idstringRequired
Responses
get
/api/v1/organizations/{organization_id}

Current User Organizations

get
Authorizations
AuthorizationstringRequired

Personal Access Token.

Query parameters
page_sizeinteger · int32Optional

The maximum number of organizations to return. If unspecified, at most 50 organizations will be returned. The maximum value is 1000; values above 1000 will be coerced to 1000.

page_tokenstringOptional

A page token, received from a previous ListCurrentUserOrganizations call. Provide this to retrieve the subsequent page. When paginating, all other parameters provided to ListCurrentUserOrganizations must match the call that provided the page token.

filterstringOptional

Optional filter string following AIP-160 filtering standards. Example: "title='My Organization'"

Responses
get
/api/v1/me/organizations

Get Organization Preferences

get
Authorizations
AuthorizationstringRequired

Personal Access Token.

Path parameters
organization_idstringRequired
Responses
get
/api/v1/organizations/{organization_id}/preferences

Get Invitation

get
Authorizations
AuthorizationstringRequired

Personal Access Token.

Path parameters
organization_idstringRequired
invitation_idstringRequired
Responses
get
/api/v1/organizations/{organization_id}/invitations/{invitation_id}

List Organization User Invites

get
Authorizations
AuthorizationstringRequired

Personal Access Token.

Path parameters
organization_idstringRequired
Query parameters
page_sizeinteger · int32Optional

The maximum number of invitations to return. If unspecified, at most 50 invitations will be returned. The maximum value is 1000; values above 1000 will be coerced to 1000.

page_tokenstringOptional

A page token, received from a previous ListOrganizationUserInvites call. Provide this to retrieve the subsequent page.

Responses
get
/api/v1/organizations/{organization_id}/invites

List Organization Roles

get
Authorizations
AuthorizationstringRequired

Personal Access Token.

Path parameters
organization_idstringRequired
Query parameters
page_sizeinteger · int32Optional

The maximum number of roles to return. If unspecified, at most 50 roles will be returned. The maximum value is 1000; values above 1000 will be coerced to 1000.

page_tokenstringOptional

A page token, received from a previous ListOrganizationRoles call. Provide this to retrieve the subsequent page.

Responses
get
/api/v1/organizations/{organization_id}/roles

List Organization Users

get
Authorizations
AuthorizationstringRequired

Personal Access Token.

Path parameters
organization_idstringRequired
Query parameters
page_sizeinteger · int32Optional

The maximum number of users to return. If unspecified, at most 50 users will be returned. The maximum value is 1000; values above 1000 will be coerced to 1000.

page_tokenstringOptional

A page token, received from a previous ListOrganizationUsers call. Provide this to retrieve the subsequent page. When paginating, all other parameters provided to ListOrganizationUsers must match the call that provided the page token.

filterstringOptional

Optional filter string following AIP-160 filtering standards. Supported filter fields:

  • role: Filter by role name (case-insensitive). Example: role="Organization Admin"
  • role_scope: Filter by role scope. Values: "organization" or "workspace". Example: role_scope=organization
  • search: Search by user display name or email (partial match). Example: search:"john"
order_bystringOptional

Optional comma-separated list of fields to order by, following AIP-132. Supported fields: display_name, email, created_time, updated_time Example: "display_name,created_time desc" Default ordering is by created_time descending if not specified.

Responses
get
/api/v1/organizations/{organization_id}/users

Get User Basic Info

get
Authorizations
AuthorizationstringRequired

Personal Access Token.

Path parameters
organization_idstringRequired
user_idstringRequired
Responses
get
/api/v1/organizations/{organization_id}/users/{user_id}

Last updated

Was this helpful?