Applications Actions

https://api.losant.com/applications

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

Get

Returns the applications the current user has permission to see

Method And Url

GET https://api.losant.com/applications

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, applications.*, or applications.get.

Request Query Parameters

Name Required Description Default Example
sortField N Field to sort the results by. Accepted values are: name, id, creationDate, ownerId, 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 * app
orgId N If not provided, return all applications. If provided but blank, only return applications belonging to the current user. If provided and an id, only return applications belonging to the given organization id. orgId=575ecdf07ae143cd83dc4a9a
summaryExclude N Comma-separated list of summary fields to exclude from application summary summaryExclude=payloadCount
summaryInclude N Comma-separated list of summary fields to include in application 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/applications

Successful Responses

Code Type Description
200 Applications Collection of applications

Error Responses

Code Type Description
400 Error Error if malformed request

Post

Create a new application

Method And Url

POST https://api.losant.com/applications

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, applications.*, or applications.post.

Request Query Parameters

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

{
  "name": "My New Application",
  "description": "Description of my new application"
}

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 Application","description":"Description of my new application"}' \
    https://api.losant.com/applications

Successful Responses

Code Type Description
201 Application Successfully created application

Error Responses

Code Type Description
400 Error Error if malformed request