Orgs Actions#

https://api.losant.com/orgs

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

Get#

Returns the organizations associated with the current user

Method And Url #

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

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 1000 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
summaryExclude N List of summary fields to exclude from org summaries summaryExclude=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

Successful Responses #

Code Type Description
200 Organizations 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/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.User, orgs.*, or orgs.post.

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 Post schema. For example, the following would be a valid body for this request:

{
  "name": "My New Organization",
  "description": "Description of my new organization"
}

Curl Example #

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

Successful Responses #

Code Type Description
201 Organization Successfully created organization

Error Responses #

Code Type Description
400 Error Error if malformed request