Skip to content
Fleet Manager

Create organization

POST
/api/v1/organizations
 
curl --request POST \
  --url http://localhost:3000/api/v1/organizations \
  --header 'Content-Type: application/json' \
  --header 'X-API-Key: <X-API-Key>' \
  --data '{ "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" }, "primaryContact": "John Smith", "billingEmail": "billing@acme-corp.com" }'

Creates a new organization. Requires Super Admin privileges.

Authorizations

Section titled “Authorizations ”

Request Body required

Section titled “Request Body required ”
Media type application/json
object
name
required

Organization display name

string
>= 2 characters <= 100 characters
Example 
Acme Corporation
slug
required

Unique URL-friendly identifier (lowercase alphanumeric with hyphens)

string
>= 2 characters <= 50 characters /^[a-z0-9]+(?:-[a-z0-9]+)*$/
Example 
acme-corp
description

Organization description

string
<= 500 characters
Example 
Leading manufacturer of industrial automation equipment
settings

Organization-specific settings

object
key
additional properties
any
Example 
{
  "timezone": "America/New_York",
  "locale": "en-US"
}
branding

Organization branding configuration

object
key
additional properties
any
Example 
{
  "primaryColor": "#003366",
  "logo": "https://example.com/logo.png"
}
primaryContact

Primary contact name for the organization

string
<= 200 characters
Example 
John Smith
billingEmail

Billing email address for the organization

string format: email
Example 
billing@acme-corp.com

Responses

Section titled “ Responses ”

201

Section titled “201 ”

Organization created successfully

Media type application/json
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
Example 
{
  "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
  }
}

400

Section titled “400 ”

Invalid input data

401

Section titled “401 ”

Unauthorized

403

Section titled “403 ”

Forbidden - Super Admin required

409

Section titled “409 ”

Organization with this slug already exists