Organization

List organization groups

get

Retrieves all groups in your organization. Groups allow you to organize users and manage access permissions at scale.

What are Groups? Groups are collections of users within your organization. They enable centralized permission management for teams, departments, or any logical user grouping.

Use Cases:

  • Organize users by department (Engineering, Sales, Operations)

  • Grant project access to entire teams at once

  • Simplify permission management for large organizations

  • Create cross-functional teams with specific access rights

Prerequisites:

  • Must have access-management or invite permission

  • Organization plan required (not available for Starter/Scale plans)

Authorizations
AuthorizationstringRequired

Enter your API key with the Bearer prefix, e.g. "Bearer QB_your_api_key_here"

Responses
200

Groups retrieved successfully - Returns array of groups with IDs and names

application/json
get
/v2/organization/groups
GET /v2/organization/groups HTTP/1.1
Host: api.qubitro.com
Authorization: YOUR_API_KEY
Accept: */*
{
  "groups": [
    {
      "id": "5f8d0d55b54764ca6f3a1234",
      "name": "Engineering Team"
    }
  ]
}

List projects of a group

get

Retrieves all projects accessible by a specific group

Authorizations
AuthorizationstringRequired

Enter your API key with the Bearer prefix, e.g. "Bearer QB_your_api_key_here"

Path parameters
group_idstringRequired

Group ID

Responses
200

Projects retrieved successfully

application/json
get
/v2/organization/groups/{group_id}/projects
GET /v2/organization/groups/{group_id}/projects HTTP/1.1
Host: api.qubitro.com
Authorization: YOUR_API_KEY
Accept: */*
[
  {
    "created_at": "2024-01-15T10:30:00Z",
    "description": "Production environment IoT devices",
    "id": "3e5c0246-c759-48e8-8345-27db13f11ff7",
    "name": "Production IoT Fleet",
    "tags": [
      "production",
      "fleet",
      "monitoring"
    ]
  }
]

Invite user to organization

post

Invite a user to join your organization with a specified role. The user will receive an email invitation and gain organization access based on their assigned role.

Organization Roles:

Role
Permissions

superadmin

Full control: all permissions including whitelabel, billing, credentials, blueprints, templates, device transfers

admin

Organization management: read, write, credentials, access management, blueprints, templates, device transfers (no billing)

readwrite

Create and edit: read, write, dashboard blueprints, function templates (no access management or credentials)

billingadmin

Billing only: read and manage billing information (limited other access)

readonly

View only: read organization resources (no modifications)

Custom Roles: Organizations can create custom roles with specific permission combinations from the available actions.

Prerequisites:

  • Must have access-management permission in the organization

  • Organization plan required (not available for Starter/Scale plans)

  • User email must be registered on the platform

  • Role must be a valid organization role ID

Authorizations
AuthorizationstringRequired

Enter your API key with the Bearer prefix, e.g. "Bearer QB_your_api_key_here"

Body
emailstringOptional

User email address

Example: [email protected]
rolestringOptional

Organization role: "superadmin", "admin", "readwrite", "billingadmin", "readonly", or custom role ID

Example: readwrite
Responses
200

Invitation sent successfully - User will receive email notification

application/json
post
/v2/organization/invite
POST /v2/organization/invite HTTP/1.1
Host: api.qubitro.com
Authorization: YOUR_API_KEY
Content-Type: application/json
Accept: */*
Content-Length: 47

{
  "email": "[email protected]",
  "role": "readwrite"
}
{
  "action": "delete device",
  "message": "Operation completed successfully",
  "success": true
}

Last updated