Organizations

Get an organization

Get organization details

get/organizations/{orgId}

Request

Path parameters

orgIdinteger required

ID of the organization

Query parameters

with_verified_statusinteger

When true, include the email verification status of each member user

withbilling_schemeboolean

When true, include the billing scheme in the response

Response

OK

successboolean

Indicates whether the request was successful.

Example response

{
  "success": true,
  "data": {
    "id": 2345,
    "name": "Smart Things LLC",
    "ownerid": 1234,
    "is_personal": 0,
    "ccemails": "finance@example.com",
    "preflight_timeout_in_days": 365,
    "users": [
      {
        "id": 1234,
        "email": "holly.graham@example.com",
        "first": "Holly",
        "last": "Graham",
        "permissions": [
          "billing",
          "activation",
          "changeplan",
          "sbconfig",
          "sbtunnel",
          "deactivate",
          "org_management"
        ]
      }
    ],
    "pending": [
      {
        "email": "newuser@example.com",
        "inviteid": 456
      }
    ]
  }
}

Changes

No recorded changes to this operation across all 1 revision of this API.