Skip to content
OTA-Pulse Docs

Get Organization

GET
/api/organizations/{organization_id}
 
curl --request GET \
  --url https://example.com/api/organizations/2489E9AD-2EE2-8E00-8EC9-32D5F69181C0 \
  --header 'Authorization: Bearer <token>'

Get organization details with stats

Authorizations

Section titled “ Authorizations ”

Parameters

Section titled “ Parameters ”

Path Parameters

Section titled “ Path Parameters ”
organization_id
required
Organization Id
string format: uuid

Responses

Section titled “ Responses ”

200

Section titled “ 200 ”

Successful Response

Media type application/json
OrganizationWithStats

Organization with additional statistics

object
active_devices
Active Devices
integer
0
created_at
required
Created At
string format: date-time
description
Any of:
string
device_count
Device Count
integer
0
id
required
Id
string format: uuid
is_active
required
Is Active
boolean
max_devices
required
Max Devices
integer
max_users
required
Max Users
integer
member_count
Member Count
integer
0
name
required
Name
string
slug
required
Slug
string
tier
required
Tier
string
Example 
{
  "active_devices": 0,
  "device_count": 0,
  "member_count": 0
}

422

Section titled “ 422 ”

Validation Error

Media type application/json
HTTPValidationError
object
detail
Detail
Array<object>
ValidationError
object
ctx
Context
object
input
Input
loc
required
Location
Array
msg
required
Message
string
type
required
Error Type
string
Example generated 
{
  "detail": [
    {
      "ctx": {},
      "input": "example",
      "loc": [
        "example"
      ],
      "msg": "example",
      "type": "example"
    }
  ]
}