Get organization by slug

GET

/api/v1/organizations/by-slug/{slug}

const url = 'http://localhost:3000/api/v1/organizations/by-slug/acme-corp';
const options = {method: 'GET', headers: {'X-API-Key': '<X-API-Key>'}};

try {
  const response = await fetch(url, options);
  const data = await response.json();
  console.log(data);
} catch (error) {
  console.error(error);
}

curl --request GET \
  --url http://localhost:3000/api/v1/organizations/by-slug/acme-corp \
  --header 'X-API-Key: <X-API-Key>'

Retrieves an organization by its URL-friendly slug.

Authorizations

api-key
bearer

Parameters

Path Parameters

slug

required

string

Example

acme-corp

Organization slug

Responses

200

Organization retrieved successfully

application/json

object

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
  }
}

401

Unauthorized

403

Forbidden — caller lacks required permission

404

Organization not found