Skip to main content

Organizations

API docs by Redocly

SAM: Organizations (0.0.0)

Download OpenAPI specification:Download

URL: https://www.snowsoftware.com

API for interacting with organizations.

Get organizations

Returns a collection of organizations.

Authorizations:
BearerAuthBearerAuth

Responses

Response samples

Content type
application/json
{
  • "nodes": [
    ]
}

Get organization

Returns the details of an organization.

Authorizations:
BearerAuthBearerAuth
path Parameters
nodeId
required
string

The unique ID of the organization.

Responses

Response samples

Content type
application/json
{
  • "id": "abe1cb12-02e6-4966-823b-82c942e278ef",
  • "parentId": "00000000-0000-0000-0000-000000000000",
  • "name": "Organization One",
  • "isLegal": true,
  • "externalId": "Organization_One"
}

Delete organization

Removes the given organization.

Authorizations:
BearerAuth
path Parameters
nodeId
required
string

The unique ID of the tree node.

Responses

Response samples

Content type
application/json
{
  • "error": {
    }
}

Create organization

Creates an organization.

Authorizations:
BearerAuth
Request Body schema: application/json
id
required
string non-empty

The client named unique ID of this organization. Used for parent - child hierarchy.

parentId
string or null

The named externalId of the parent to this organization. Used for parent - child hierarchy.

name
required
string non-empty

The display name of the organization.

isLegal
boolean

true if is legal; otherwise, false.

Responses

Request samples

Content type
application/json
{
  • "id": "Organization_Two",
  • "parentId": "Organization_One",
  • "name": "Organization Two",
  • "isLegal": true
}

Response samples

Content type
application/json
{
  • "id": "f3fce297-1ab4-4665-b927-51d3c46cb2c5",
  • "parentId": "abe1cb12-02e6-4966-823b-82c942e278ef",
  • "name": "Organization Two",
  • "isLegal": true,
  • "externalId": "Organization_Two"
}