Below are the various requests that can be performed against the
Instance Org resource, as well as the expected
parameters and the potential responses.
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
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
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: