Skip to content
Fleet Manager

List organizations

GET
/api/v1/organizations
 
curl --request GET \
  --url 'http://localhost:3000/api/v1/organizations?search=acme&name=Acme%20Corporation&active=true&status=active&limit=50&offset=0' \
  --header 'X-API-Key: <X-API-Key>'

Retrieves a list of all organizations. Requires Super Admin privileges.

Authorizations

Section titled “Authorizations ”

Parameters

Section titled “ Parameters ”

Query Parameters

Section titled “Query Parameters ”
search
string
Example 
acme

Search term for organization name or slug

name
string
Example 
Acme Corporation

Filter by exact organization name

active
deprecated
boolean
Example 
true

Filter by active status (deprecated, use status filter)

status
string
Allowed values: active suspended pending disabled
Example 
active

Filter by organization status

limit
number
default: 50 >= 1 <= 100
Example 
50

Maximum number of results to return

offset
number
0
Example 
0

Number of results to skip for pagination

Responses

Section titled “ Responses ”

200

Section titled “200 ”

Organizations retrieved successfully

Media type application/json
object
items
required

List of organizations

Array<object>
object
id
required

Unique organization identifier

string format: uuid
name
required

Organization display name

string
slug
required

Unique URL-friendly identifier

string
description

Organization description

string
settings
required

Organization-specific settings

object
key
additional properties
any
branding
required

Organization branding configuration

object
key
additional properties
any
status
required

Organization status

string
Allowed values: active suspended pending disabled
lastActivityAt

Last activity timestamp

string format: date-time
nullable
primaryContact

Primary contact name

string
nullable
billingEmail

Billing email address

string format: email
nullable
active
required

Whether the organization is active (deprecated, use status)

boolean
createdAt
required

When the organization was created

string format: date-time
updatedAt
required

When the organization was last updated

string format: date-time
stats

Organization resource statistics

object
userCount
required

Total number of users in the organization

number
activeUsers
required

Number of active users in the organization

number
deviceCount
required

Total number of devices in the organization

number
activeDevices
required

Number of online or provisioned devices

number
deploymentCount
required

Total number of deployments in the organization

number
runningDeployments
required

Number of running deployments

number
total
required

Total number of organizations matching the query

number
limit
required

Number of results returned

number
offset
required

Number of results skipped

number
Example 
{
  "items": [
    {
      "id": "550e8400-e29b-41d4-a716-446655440000",
      "name": "Acme Corporation",
      "slug": "acme-corp",
      "description": "Leading manufacturer of industrial automation equipment",
      "settings": {
        "timezone": "America/New_York",
        "locale": "en-US"
      },
      "branding": {
        "primaryColor": "#003366",
        "logo": "https://example.com/logo.png"
      },
      "status": "active",
      "lastActivityAt": "2024-06-20T14:45:00Z",
      "primaryContact": "John Smith",
      "billingEmail": "billing@acme-corp.com",
      "active": true,
      "createdAt": "2024-01-15T10:30:00Z",
      "updatedAt": "2024-06-20T14:45:00Z",
      "stats": {
        "userCount": 25,
        "activeUsers": 20,
        "deviceCount": 150,
        "activeDevices": 120,
        "deploymentCount": 42,
        "runningDeployments": 35
      }
    }
  ],
  "total": 100,
  "limit": 50,
  "offset": 0
}

401

Section titled “401 ”

Unauthorized

403

Section titled “403 ”

Forbidden - Super Admin required