Below are the various requests that can be performed against the
Org 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
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
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
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:
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
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
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
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
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
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: