Instance Organizations Actions

https://api.losant.com/instances/INSTANCE_ID/orgs

Below are the various requests that can be performed against the Instance Organizations resource, as well as the expected parameters and the potential responses.

Get

Returns the organizations associated with the current instance

Method And Url

GET https://api.losant.com/instances/INSTANCE_ID/orgs

Authentication

A valid API access token is required to access this endpoint. The token must include at least one of the following scopes: all.Instance, all.Instance.read, all.User, all.User.read, instanceOrgs.*, or instanceOrgs.get.

Request Path Components

Path Component	Description	Example
INSTANCE_ID	ID associated with the instance	575ec8687ae143cd83dc4a97

Request Query Parameters

Name	Required	Description	Default	Example
sortField	N	Field to sort the results by. Accepted values are: name, id, creationDate, lastUpdated	name	sortField=name
sortDirection	N	Direction to sort the results by. Accepted values are: asc, desc	asc	sortDirection=asc
page	N	Which page of results to return	0	page=0
perPage	N	How many items to return per page	100	perPage=10
filterField	N	Field to filter the results by. Blank or not provided means no filtering. Accepted values are: name		filterField=name
filter	N	Filter to apply against the filtered field. Supports globbing. Blank or not provided means no filtering.		filter=my*org
summaryInclude	N	Comma-separated list of summary fields to include in org summary		summaryInclude=payloadCount
query	N	Organization filter JSON object which overrides all other filter params. See Advanced Instance Organization Query for more details.		query={"name":"Bob's Org","lastUpdated":"2022-01-30T17:18:11.911Z"}

Request Headers

Name	Required	Description	Default
Authorization	Y	The token for authenticating the request, prepended with Bearer

Curl Example

curl -H 'Content-Type: application/json' \
    -H 'Accept: application/json' \
    -H 'Authorization: Bearer YOUR_API_ACCESS_TOKEN' \
    -X GET \
    https://api.losant.com/instances/INSTANCE_ID/orgs

Successful Responses

Code	Type	Description
200	Instance Organizations	A collection of organizations

Error Responses

Code	Type	Description
400	Error	Error if malformed request

Post

Create a new organization

Method And Url

POST https://api.losant.com/instances/INSTANCE_ID/orgs

Authentication

A valid API access token is required to access this endpoint. The token must include at least one of the following scopes: all.Instance, all.User, instanceOrgs.*, or instanceOrgs.post.

Request Path Components

Path Component	Description	Example
INSTANCE_ID	ID associated with the instance	575ec8687ae143cd83dc4a97

Request Query Parameters

Name	Required	Description	Default	Example
summaryInclude	N	Comma-separated list of summary fields to include in org summary		summaryInclude=payloadCount

Request Headers

Name	Required	Description	Default
Authorization	Y	The token for authenticating the request, prepended with Bearer

Request Body

The body of the request should be serialized JSON that validates against the Instance Owned Organization Post schema. For example, the following would be a valid body for this request:

{
  "name": "My Org",
  "limits": {
    "member": 500
  },
  "auditLogEnabled": true
}

Curl Example

curl -H 'Content-Type: application/json' \
    -H 'Accept: application/json' \
    -H 'Authorization: Bearer YOUR_API_ACCESS_TOKEN' \
    -X POST \
    https://api.losant.com/instances/INSTANCE_ID/orgs

Successful Responses

Code	Type	Description
200	Organization	The newly created organization

Error Responses

Code	Type	Description
400	Error	Error if malformed request

Schemas

Advanced Instance Organization Query

Schema for advanced instance organization queries

Advanced Instance Organization Query Schema

▶
root:{} 4 keys
$schema:"http://json-schema.org/draft-07/schema#"
type:"object"
▶
properties:{} 14 keys
▶
$and:{} 3 keys
▶
$or:{} 3 keys
▶
$nor:{} 3 keys
▶
id:{} 1 key
▶
creationDate:{} 1 key
▶
lastUpdated:{} 1 key
▶
name:{} 1 key
▶
mfaMode:{} 1 key
▶
isReadOnly:{} 1 key
▶
auditLogEnabled:{} 1 key
▶
disabledAt:{} 1 key
▶
referralId:{} 1 key
▶
tags:{} 1 key
▶
memberId:{} 1 key
additionalProperties:false

Advanced Instance Organization Query Example

▶
root:{} 2 keys
name:"Bob's Org"
lastUpdated:"2022-01-30T17:18:11.911Z"

Error

Schema for errors returned by the API

Error Schema

▶
root:{} 3 keys
$schema:"http://json-schema.org/draft-07/schema#"
type:"object"
▶
properties:{} 2 keys
▶
type:{} 1 key
▶
message:{} 1 key

Error Example

▶
root:{} 2 keys
type:"NotFound"
message:"Application was not found"

Instance Owned Organization Post

Schema for the body of an Organization creation request within an instance

Instance Owned Organization Post Schema

▶
root:{} 5 keys
$schema:"http://json-schema.org/draft-07/schema#"
type:"object"
▶
properties:{} 13 keys
▶
name:{} 3 keys
▶
description:{} 2 keys
▶
iconColor:{} 2 keys
▶
limits:{} 3 keys
▶
members:{} 3 keys
▶
whitelistedEmailDomains:{} 2 keys
▶
auditLogEnabled:{} 1 key
▶
disabledAt:{} 1 key
▶
isReadOnly:{} 1 key
▶
tags:{} 3 keys
▶
referralId:{} 2 keys
▶
mfaMode:{} 2 keys
▶
banner:{} 3 keys
additionalProperties:false
▶
required:[] 1 item

Instance Owned Organization Post Example

▶
root:{} 3 keys
name:"My Org"
▶
limits:{} 1 key
auditLogEnabled:true

Instance Organizations

Schema for a collection of Organizations within an instance

Instance Organizations Schema

▶
root:{} 3 keys
$schema:"http://json-schema.org/draft-07/schema#"
type:"object"
▶
properties:{} 10 keys
▶
items:{} 2 keys
▶
instanceId:{} 2 keys
▶
count:{} 1 key
▶
totalCount:{} 1 key
▶
perPage:{} 1 key
▶
page:{} 1 key
▶
filter:{} 1 key
▶
filterField:{} 1 key
▶
sortField:{} 1 key
▶
sortDirection:{} 2 keys

Instance Organizations Example

▶
root:{} 7 keys
▶
items:[] 1 item
count:1
totalCount:2
perPage:1
page:0
sortField:"name"
sortDirection:"asc"

Organization

Schema for a single Organization

Organization Schema

▶
root:{} 3 keys
$schema:"http://json-schema.org/draft-07/schema#"
type:"object"
▶
properties:{} 21 keys
▶
id:{} 2 keys
▶
orgId:{} 2 keys
▶
creationDate:{} 2 keys
▶
lastUpdated:{} 2 keys
▶
name:{} 3 keys
▶
description:{} 2 keys
▶
members:{} 2 keys
▶
limits:{} 3 keys
▶
summary:{} 2 keys
▶
planId:{} 2 keys
▶
billingEmail:{} 3 keys
▶
subscriptionStatus:{} 2 keys
▶
currentPeriodStart:{} 2 keys
▶
currentPeriodEnd:{} 2 keys
▶
isEnterprise:{} 1 key
▶
iconColor:{} 2 keys
▶
whitelistedEmailDomains:{} 2 keys
▶
disabledAt:{} 1 key
▶
isReadOnly:{} 1 key
▶
mfaMode:{} 2 keys
▶
banner:{} 3 keys

Organization Example

▶
root:{} 8 keys
id:"575ed6e87ae143cd83dc4aa8"
orgId:"575ed6e87ae143cd83dc4aa8"
creationDate:"2016-06-13T04:00:00.000Z"
lastUpdated:"2016-06-13T04:00:00.000Z"
name:"My Organization"
description:"My organization description"
▶
members:[] 2 items
▶
summary:{} 7 keys