Instance Organization Actions

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

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

Delete

Deletes an organization

Method And Url

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

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, instanceOrg.*, or instanceOrg.delete.

Request Path Components

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

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 DELETE \
    https://api.losant.com/instances/INSTANCE_ID/orgs/ORG_ID

Successful Responses

Code	Type	Description
200	Success	If organization was successfully deleted

Error Responses

Code	Type	Description
400	Error	Error if malformed request
404	Error	Error if instance or organization was not found

Device Counts

Returns device counts by day for the time range specified for this organization

Method And Url

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

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, instanceOrg.*, or instanceOrg.deviceCounts.

Request Path Components

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

Request Query Parameters

Name	Required	Description	Default	Example
start	N	Start of range for device count query (ms since epoch)		start=0
end	N	End of range for device count query (ms since epoch)	0	end=1465790400000

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/ORG_ID/deviceCounts

Successful Responses

Code	Type	Description
200	Device Counts	Device counts by day

Error Responses

Code	Type	Description
400	Error	Error if malformed request
404	Error	Error if instance or organization was not found

Get

Retrieves information on an organization

Method And Url

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

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, instanceOrg.*, or instanceOrg.get.

Request Path Components

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

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

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/ORG_ID

Successful Responses

Code	Type	Description
200	Instance Organization	A single organization

Error Responses

Code	Type	Description
400	Error	Error if malformed request
404	Error	Error if instance or organization was not found

Notebook Minute Counts

Returns notebook execution usage by day for the time range specified for this organization

Method And Url

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

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, instanceOrg.*, or instanceOrg.notebookMinuteCounts.

Request Path Components

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

Request Query Parameters

Name	Required	Description	Default	Example
start	N	Start of range for notebook execution query (ms since epoch)		start=0
end	N	End of range for notebook execution query (ms since epoch)		end=1465790400000

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/ORG_ID/notebookMinuteCounts

Successful Responses

Code	Type	Description
200	Notebook Minute Counts	Notebook usage information

Error Responses

Code	Type	Description
400	Error	Error if malformed request
404	Error	Error if instance or organization was not found

Patch

Updates information about an organization

Method And Url

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

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, instanceOrg.*, or instanceOrg.patch.

Request Path Components

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

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 Patch 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 PATCH \
    -d '{"name":"My Org","limits":{"member":500},"auditLogEnabled":true}' \
    https://api.losant.com/instances/INSTANCE_ID/orgs/ORG_ID

Successful Responses

Code	Type	Description
200	Instance Organization	Updated organization information

Error Responses

Code	Type	Description
400	Error	Error if malformed request
404	Error	Error if instance or organization was not found

Payload Counts

Returns payload counts for the time range specified for all applications this organization owns

Method And Url

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

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, instanceOrg.*, or instanceOrg.payloadCounts.

Request Path Components

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

Request Query Parameters

Name	Required	Description	Default	Example
start	N	Start of range for payload count query (ms since epoch)		start=0
end	N	End of range for payload count query (ms since epoch)		end=1465790400000
asBytes	N	If the resulting stats should be returned as bytes	false	asBytes=true

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/ORG_ID/payloadCounts

Successful Responses

Code	Type	Description
200	Payload Stats	Payload counts, by type and source

Error Responses

Code	Type	Description
400	Error	Error if malformed request
404	Error	Error if instance or organization was not found

Payload Counts Breakdown

Returns payload counts per resolution in the time range specified for all application this organization owns

Method And Url

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

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, instanceOrg.*, or instanceOrg.payloadCountsBreakdown.

Request Path Components

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

Request Query Parameters

Name	Required	Description	Default	Example
start	N	Start of range for payload count query (ms since epoch)		start=0
end	N	End of range for payload count query (ms since epoch)		end=1465790400000
resolution	N	Resolution in milliseconds. Accepted values are: 86400000, 3600000	86400000	resolution=86400000
asBytes	N	If the resulting stats should be returned as bytes	false	asBytes=true
includeNonBillable	N	If non-billable payloads should be included in the result	false	includeNonBillable=true

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/ORG_ID/payloadCountsBreakdown

Successful Responses

Code	Type	Description
200	Payload Counts Breakdown	Payload counts, by type and source

Error Responses

Code	Type	Description
400	Error	Error if malformed request
404	Error	Error if instance or organization was not found

Schemas

Device Counts

Schema for the result of a device counts request

Device Counts Schema

▶
root:{} 3 keys
$schema:"http://json-schema.org/draft-07/schema#"
type:"object"
▶
properties:{} 3 keys
▶
start:{} 2 keys
▶
end:{} 2 keys
▶
counts:{} 2 keys

Device Counts Example

▶
root:{} 3 keys
start:"1999-05-20T05:00:00.000Z"
end:"1999-06-20T04:59:59.999Z"
▶
counts:[] 1 item

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 Organization

Schema for the body of an Organization owned by an instance

Instance Organization Schema

▶
root:{} 5 keys
$schema:"http://json-schema.org/draft-07/schema#"
type:"object"
▶
properties:{} 25 keys
▶
creationDate:{} 2 keys
▶
lastUpdated:{} 2 keys
▶
name:{} 3 keys
▶
id:{} 2 keys
▶
orgId:{} 2 keys
▶
instanceId:{} 2 keys
▶
description:{} 2 keys
▶
iconColor:{} 2 keys
▶
limits:{} 3 keys
▶
summary:{} 2 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
▶
planId:{} 2 keys
▶
customerId:{} 2 keys
▶
subscriptionId:{} 2 keys
▶
billingEmail:{} 3 keys
▶
subscriptionStatus:{} 2 keys
▶
currentPeriodStart:{} 2 keys
▶
currentPeriodEnd:{} 2 keys
additionalProperties:false
▶
required:[] 1 item

Instance Organization Example

▶
root:{} 19 keys
creationDate:"2022-10-26T19:27:42.736Z"
lastUpdated:"2024-10-24T17:04:32.009Z"
name:"My Org"
id:"60106426dc03c6aad06540bb"
orgId:"60106426dc03c6aad06540bb"
instanceId:"60106426dc03c6aad06560ba"
description:"My Org Description"
iconColor:"#057180"
▶
limits:{} 33 keys
▶
summary:{} 27 keys
whitelistedEmailDomains:[] 0 items
auditLogEnabled:false
disabledAt:false
isReadOnly:false
▶
tags:[] 1 item
mfaMode:"notRequired"
▶
banner:{} 2 keys
currentPeriodStart:"2023-01-01T00:00:00.000Z"
currentPeriodEnd:"2023-01-31T11:59:59.999Z"

Instance Owned Organization Patch

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

Instance Owned Organization Patch Schema

▶
root:{} 4 keys
$schema:"http://json-schema.org/draft-07/schema#"
type:"object"
▶
properties:{} 12 keys
▶
name:{} 3 keys
▶
description:{} 2 keys
▶
iconColor:{} 2 keys
▶
limits:{} 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

Instance Owned Organization Patch Example

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

Notebook Minute Counts

Schema for the result of a notebook minute counts request

Notebook Minute Counts Schema

▶
root:{} 3 keys
$schema:"http://json-schema.org/draft-07/schema#"
type:"object"
▶
properties:{} 3 keys
▶
start:{} 2 keys
▶
end:{} 2 keys
▶
counts:{} 2 keys

Notebook Minute Counts Example

▶
root:{} 3 keys
start:"1999-05-20T05:00:00.000Z"
end:"1999-06-20T04:59:59.999Z"
▶
counts:[] 1 item

Payload Counts Breakdown

Schema for the result of a payload counts breakdown request

Payload Counts Breakdown Schema

▶
root:{} 3 keys
$schema:"http://json-schema.org/draft-07/schema#"
type:"object"
▶
properties:{} 3 keys
▶
start:{} 2 keys
▶
end:{} 2 keys
▶
counts:{} 2 keys

Payload Counts Breakdown Example

▶
root:{} 3 keys
start:"1999-05-20T05:00:00.000Z"
end:"1999-06-20T04:59:59.999Z"
▶
counts:[] 1 item

Payload Stats

Schema for the result of a payload stats request

Payload Stats Schema

▶
root:{} 3 keys
$schema:"http://json-schema.org/draft-07/schema#"
type:"object"
▶
properties:{} 19 keys
▶
appFile:{} 2 keys
▶
dataTable:{} 2 keys
▶
deviceCreate:{} 2 keys
▶
deviceCommand:{} 2 keys
▶
deviceConnect:{} 2 keys
▶
deviceDisconnect:{} 2 keys
▶
deviceState:{} 2 keys
▶
endpoint:{} 2 keys
▶
event:{} 2 keys
▶
flowError:{} 2 keys
▶
inboundEmail:{} 2 keys
▶
integration:{} 2 keys
▶
mqttIn:{} 2 keys
▶
mqttOut:{} 2 keys
▶
notebook:{} 2 keys
▶
resourceJob:{} 2 keys
▶
timer:{} 2 keys
▶
virtualButton:{} 2 keys
▶
webhook:{} 2 keys

Payload Stats Example

▶
root:{} 6 keys
▶
timer:{} 1 key
▶
deviceState:{} 2 keys
▶
mqttOut:{} 1 key
▶
webhook:{} 1 key
▶
deviceConnect:{} 1 key
▶
deviceDisconnect:{} 1 key

Success

Schema for reporting a successful operation

Success Schema

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

Success Example

▶
root:{} 1 key
success:true