Organization Actions

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

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

Delete

Deletes an organization

Method And Url

DELETE https://api.losant.com/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.Organization, all.User, org.*, or org.delete.

Request Path Components

Path Component Description Example
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/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 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/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.Organization, all.Organization.read, all.User, all.User.read, org.*, or org.deviceCounts.

Request Path Components

Path Component Description Example
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) 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/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 organization was not found

Get

Retrieves information on an organization

Method And Url

GET https://api.losant.com/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.Organization, all.Organization.read, all.User, all.User.read, org.*, or org.get.

Request Path Components

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

Request Query Parameters

Name Required Description Default Example
summaryExclude N Comma-separated list of summary fields to exclude from org summary summaryExclude=payloadCount
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/orgs/ORG_ID

Successful Responses

Code Type Description
200 Organization Organization information

Error Responses

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

Invite Member

Invites a person to an organization

Method And Url

POST https://api.losant.com/orgs/ORG_ID/invites

Authentication

A valid api access token is required to access this endpoint. The token must include at least one of the following scopes: all.Organization, all.User, org.*, or org.inviteMember.

Request Path Components

Path Component Description Example
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

Request Body

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

{
  "email": "invitedUser@example.com",
  "role": "edit"
}

Curl Example 

curl -H 'Content-Type: application/json' \
    -H 'Accept: application/json' \
    -H 'Authorization: Bearer YOUR_API_ACCESS_TOKEN' \
    -X POST \
    -d '{"email":"invitedUser@example.com","role":"edit"}' \
    https://api.losant.com/orgs/ORG_ID/invites

Successful Responses

Code Type Description
200 Organization Invitations Invitation information

Error Responses

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

Modify Member

Modifies a current org member’s role

Method And Url

PATCH https://api.losant.com/orgs/ORG_ID/member

Authentication

A valid api access token is required to access this endpoint. The token must include at least one of the following scopes: all.Organization, all.User, org.*, or org.modifyMember.

Request Path Components

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

Request Query Parameters

Name Required Description Default Example
summaryExclude N Comma-separated list of summary fields to exclude from org summary summaryExclude=payloadCount
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 Organization Member Patch schema. For example, the following would be a valid body for this request:

{
  "userId": "575ef90f7ae143cd83dc4aad",
  "role": "view"
}

Curl Example 

curl -H 'Content-Type: application/json' \
    -H 'Accept: application/json' \
    -H 'Authorization: Bearer YOUR_API_ACCESS_TOKEN' \
    -X PATCH \
    -d '{"userId":"575ef90f7ae143cd83dc4aad","role":"view"}' \
    https://api.losant.com/orgs/ORG_ID/member

Successful Responses

Code Type Description
200 Organization Updated organization information

Error Responses

Code Type Description
400 Error Error if malformed request
404 Error Error if organization 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/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.Organization, all.Organization.read, all.User, all.User.read, org.*, or org.notebookMinuteCounts.

Request Path Components

Path Component Description Example
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/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 organization was not found

Patch

Updates information about an organization

Method And Url

PATCH https://api.losant.com/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.Organization, all.User, org.*, or org.patch.

Request Path Components

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

Request Query Parameters

Name Required Description Default Example
summaryExclude N Comma-separated list of summary fields to exclude from org summary summaryExclude=payloadCount
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 Organization Patch schema. For example, the following would be a valid body for this request:

{
  "name": "My Updated Organization",
  "description": "Description of my updated organization"
}

Curl Example 

curl -H 'Content-Type: application/json' \
    -H 'Accept: application/json' \
    -H 'Authorization: Bearer YOUR_API_ACCESS_TOKEN' \
    -X PATCH \
    -d '{"name":"My Updated Organization","description":"Description of my updated organization"}' \
    https://api.losant.com/orgs/ORG_ID

Successful Responses

Code Type Description
200 Organization Updated organization information

Error Responses

Code Type Description
400 Error Error if malformed request
404 Error Error if 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/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.Organization, all.Organization.read, all.User, all.User.read, org.*, or org.payloadCounts.

Request Path Components

Path Component Description Example
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

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/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 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/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.Organization, all.Organization.read, all.User, all.User.read, org.*, or org.payloadCountsBreakdown.

Request Path Components

Path Component Description Example
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/orgs/ORG_ID/payloadCountsBreakdown

Successful Responses

Code Type Description
200 Payload Counts Breakdown Sum of payload counts by date

Error Responses

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

Pending Invites

Gets the current pending invites

Method And Url

GET https://api.losant.com/orgs/ORG_ID/invites

Authentication

A valid api access token is required to access this endpoint. The token must include at least one of the following scopes: all.Organization, all.Organization.read, all.User, all.User.read, org.*, or org.pendingInvites.

Request Path Components

Path Component Description Example
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 GET \
    https://api.losant.com/orgs/ORG_ID/invites

Successful Responses

Code Type Description
200 Organization Invitations Invitation information

Error Responses

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

Remove Member

Removes a member from the org

Method And Url

DELETE https://api.losant.com/orgs/ORG_ID/member

Authentication

A valid api access token is required to access this endpoint. The token must include at least one of the following scopes: all.Organization, all.User, org.*, or org.removeMember.

Request Path Components

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

Request Query Parameters

Name Required Description Default Example
userId Y Id of user to remove userId=575ed70c7ae143cd83dc4aa9
summaryExclude N Comma-separated list of summary fields to exclude from org summary summaryExclude=payloadCount
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 DELETE \
    https://api.losant.com/orgs/ORG_ID/member?userId=575ed70c7ae143cd83dc4aa9

Successful Responses

Code Type Description
200 Organization Updated organization information

Error Responses

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

Revoke Invite

Revokes an existing invite

Method And Url

DELETE https://api.losant.com/orgs/ORG_ID/invites

Authentication

A valid api access token is required to access this endpoint. The token must include at least one of the following scopes: all.Organization, all.User, org.*, or org.revokeInvite.

Request Path Components

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

Request Query Parameters

Name Required Description Default Example
inviteId Y Id of invite to revoke inviteId=575ed71e7ae143cd83dc4aaa

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/orgs/ORG_ID/invites?inviteId=575ed71e7ae143cd83dc4aaa

Successful Responses

Code Type Description
200 Organization Invitations Invitation information

Error Responses

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

Transfer Resources

Moves resources to a new owner

Method And Url

PATCH https://api.losant.com/orgs/ORG_ID/transferResources

Authentication

A valid api access token is required to access this endpoint. The token must include at least one of the following scopes: all.Organization, all.User, org.*, or org.transferResources.

Request Path Components

Path Component Description Example
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

Request Body

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

{
  "destinationId": "575ed6e87ae143cd83dc4aa8",
  "destinationType": "organization",
  "applicationIds": [
    "575ec8687ae143cd83dc4a97"
  ]
}

Curl Example 

curl -H 'Content-Type: application/json' \
    -H 'Accept: application/json' \
    -H 'Authorization: Bearer YOUR_API_ACCESS_TOKEN' \
    -X PATCH \
    -d '{"destinationId":"575ed6e87ae143cd83dc4aa8","destinationType":"organization","applicationIds":["575ec8687ae143cd83dc4a97"]}' \
    https://api.losant.com/orgs/ORG_ID/transferResources

Successful Responses

Code Type Description
200 Success If resource transfer was successful

Error Responses

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

Was this page helpful?

Still looking for help? You can also search the Losant Forums or submit your question there.