Organizations

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

Get Organization

get

Authorizations

BearerAuth

AuthorizationstringRequired

Personal Access Token.

Path parameters

organization_idstringRequired

Responses

200

A successful response.

application/json

An Organization is the top-level resource container.

namestringOptional

The resource name of the organization. Format: organizations/{organization_id} This field is assigned by the server at creation and is immutable thereafter. Clients may include this field in Get/Update/Delete requests to identify the resource.

titlestringRequired

The user-defined display name for the organization.

logo_data_uristringOptional

create_timestring · date-timeRead-onlyOptional

The timestamp when the organization was created.

update_timestring · date-timeRead-onlyOptional

The timestamp when the organization was last updated.

owner_display_namestringRead-onlyOptional

The display name of the organization owner.

owner_emailstringRead-onlyOptional

The email address of the organization owner.

default

An unexpected error response.

application/json

get

/api/v1/organizations/{organization_id}

HTTPcURLJavaScriptPython

GET /api/v1/organizations/{organization_id} HTTP/1.1
Host: app.us-1.kognitos.com
Authorization: Bearer YOUR_SECRET_TOKEN
Accept: */*

{
  "name": "text",
  "title": "text",
  "logo_data_uri": "text",
  "create_time": "2026-03-12T12:04:47.466Z",
  "update_time": "2026-03-12T12:04:47.466Z",
  "owner_display_name": "text",
  "owner_email": "text"
}

Current User Organizations

get

Authorizations

BearerAuth

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

200

A successful response.

application/json

Response message for listing organizations for the current user.

next_page_tokenstringOptional

A token to retrieve the next page of results. Pass this value in the page_token field in the subsequent call to CurrentUserOrganizations to get the next page of results. If this field is empty, it means there are no more results.

default

An unexpected error response.

application/json

get

/api/v1/me/organizations

HTTPcURLJavaScriptPython

GET /api/v1/me/organizations HTTP/1.1
Host: app.us-1.kognitos.com
Authorization: Bearer YOUR_SECRET_TOKEN
Accept: */*

{
  "user_organizations": [
    {
      "name": "text",
      "title": "text",
      "logo_data_uri": "text",
      "create_time": "2026-03-12T12:04:47.466Z",
      "update_time": "2026-03-12T12:04:47.466Z",
      "owner_display_name": "text",
      "owner_email": "text"
    }
  ],
  "next_page_token": "text"
}

Get Organization Preferences

get

Authorizations

BearerAuth

AuthorizationstringRequired

Personal Access Token.

Path parameters

organization_idstringRequired

Responses

200

A successful response.

application/json

Represents organization-specific settings or preferences.

namestringOptional

support_team_accessbooleanOptional

Support team access to workspaces in the organization for debugging issues.

default

An unexpected error response.

application/json

get

/api/v1/organizations/{organization_id}/preferences

HTTPcURLJavaScriptPython

GET /api/v1/organizations/{organization_id}/preferences HTTP/1.1
Host: app.us-1.kognitos.com
Authorization: Bearer YOUR_SECRET_TOKEN
Accept: */*

{
  "name": "text",
  "support_team_access": true,
  "general": {
    "time_zone": "text",
    "time_format": "TIME_FORMAT_UNSPECIFIED",
    "date_format": "DATE_FORMAT_UNSPECIFIED",
    "decimal_symbol": "DECIMAL_SYMBOL_UNSPECIFIED",
    "decimal_places": 1,
    "measurement_system": "MEASUREMENT_SYSTEM_UNSPECIFIED"
  }
}

Get Invitation

get

Authorizations

BearerAuth

AuthorizationstringRequired

Personal Access Token.

Path parameters

organization_idstringRequired

invitation_idstringRequired

Responses

200

A successful response.

application/json

An Invitation represents a pending invitation to join an organization or workspace.

namestringOptional

organization_display_namestringOptional

The organization display name.

workspace_idstringOptional

The workspace ID (not set if org-level invite).

workspace_display_namestringOptional

The workspace display name (not set if org-level invite).

rolesstring[]Optional

List of role resource names included in this invitation.

is_acceptedbooleanOptional

Whether the invitation has been accepted.

redirect_organization_idstringOptional

The organization ID to redirect to (set if invitation points to a different org).

redirect_workspace_idstringOptional

The workspace ID to redirect to (set if invitation points to a different workspace).

default

An unexpected error response.

application/json

get

/api/v1/organizations/{organization_id}/invitations/{invitation_id}

HTTPcURLJavaScriptPython

GET /api/v1/organizations/{organization_id}/invitations/{invitation_id} HTTP/1.1
Host: app.us-1.kognitos.com
Authorization: Bearer YOUR_SECRET_TOKEN
Accept: */*

{
  "name": "text",
  "organization_display_name": "text",
  "workspace_id": "text",
  "workspace_display_name": "text",
  "roles": [
    "text"
  ],
  "is_accepted": true,
  "redirect_organization_id": "text",
  "redirect_workspace_id": "text"
}

List Organization User Invites

get

Authorizations

BearerAuth

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

200

A successful response.

application/json

Response message for ListOrganizationUserInvites.

next_page_tokenstringOptional

A token to retrieve the next page of results. Pass this value in the page_token field in the subsequent call to ListOrganizationUserInvites to get the next page of results.

default

An unexpected error response.

application/json

get

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

HTTPcURLJavaScriptPython

GET /api/v1/organizations/{organization_id}/invites HTTP/1.1
Host: app.us-1.kognitos.com
Authorization: Bearer YOUR_SECRET_TOKEN
Accept: */*

{
  "invitations": [
    {
      "email": "text",
      "invitation_id": "text"
    }
  ],
  "next_page_token": "text"
}

List Organization Roles

get

Authorizations

BearerAuth

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

200

A successful response.

application/json

Response message for ListOrganizationRoles.

next_page_tokenstringOptional

A token to retrieve the next page of results. Pass this value in the page_token field in the subsequent call to ListOrganizationRoles to get the next page of results.

default

An unexpected error response.

application/json

get

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

HTTPcURLJavaScriptPython

GET /api/v1/organizations/{organization_id}/roles HTTP/1.1
Host: app.us-1.kognitos.com
Authorization: Bearer YOUR_SECRET_TOKEN
Accept: */*

{
  "roles": [
    {
      "name": "text",
      "title": "text",
      "description": "text",
      "permissions": [
        "text"
      ]
    }
  ],
  "next_page_token": "text"
}

List Organization Users

get

Authorizations

BearerAuth

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

200

A successful response.

application/json

Response message for listing users in an organization.

next_page_tokenstringOptional

A token to retrieve the next page of results. Pass this value in the page_token field in the subsequent call to ListOrganizationUsers to get the next page of results. If this field is empty, it means there are no more results.

default

An unexpected error response.

application/json

get

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

HTTPcURLJavaScriptPython

GET /api/v1/organizations/{organization_id}/users HTTP/1.1
Host: app.us-1.kognitos.com
Authorization: Bearer YOUR_SECRET_TOKEN
Accept: */*

{
  "users": [
    {
      "user": {
        "name": "text",
        "display_name": "text",
        "email": "text"
      },
      "roles": [
        {
          "name": "text",
          "role_scope": "ROLE_SCOPE_UNSPECIFIED"
        }
      ]
    }
  ],
  "next_page_token": "text"
}

Get User Basic Info

get

Authorizations

BearerAuth

AuthorizationstringRequired

Personal Access Token.

Path parameters

organization_idstringRequired

user_idstringRequired

Responses

200

A successful response.

application/json

Contains basic information about a user. This is a lightweight representation used when full user details are not needed.

namestringOptional

display_namestringOptional

The user's display name.

emailstringOptional

The user's email address.

default

An unexpected error response.

application/json

get

/api/v1/organizations/{organization_id}/users/{user_id}

HTTPcURLJavaScriptPython

GET /api/v1/organizations/{organization_id}/users/{user_id} HTTP/1.1
Host: app.us-1.kognitos.com
Authorization: Bearer YOUR_SECRET_TOKEN
Accept: */*

{
  "name": "text",
  "display_name": "text",
  "email": "text"
}