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

Was this page helpful?

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