Experience Users Actions

https://api.losant.com/applications/APPLICATION_ID/experience/users

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

Get

Returns the experience users for an application

Method And Url

GET https://api.losant.com/applications/APPLICATION_ID/experience/users

Authentication

A valid API access token is required to access this endpoint. The token must include at least one of the following scopes: all.Application, all.Application.read, all.Organization, all.Organization.read, all.User, all.User.read, experienceUsers.*, or experienceUsers.get.

Request Path Components

Path Component	Description	Example
APPLICATION_ID	ID associated with the application	575ec8687ae143cd83dc4a97

Request Query Parameters

Name	Required	Description	Default	Example
sortField	N	Field to sort the results by. Accepted values are: firstName, lastName, email, id, creationDate, lastLogin, lastUpdated	email	sortField=email
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: firstName, lastName, email		filterField=email
filter	N	Filter to apply against the filtered field. Supports globbing. Blank or not provided means no filtering.		filter=my*user
experienceGroupId	N	Filter users to those only in the specified group, special experienceGroupIds of 'any' which will give users who are in at least one group and 'none' will give you users who are not in any groups.		experienceGroupId=575ec8687ae143cd83dc4a97
includeAncestorGroups	N	If set will include members from ancestors of the specified experienceGroupId		includeAncestorGroups=true
query	N	Experience user filter JSON object which overrides all other filter params. See Advanced Experience User Query for more details.		query={"firstName":"Bob","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/applications/APPLICATION_ID/experience/users

Successful Responses

Code	Type	Description
200	Experience Users	Collection of experience users

Error Responses

Code	Type	Description
400	Error	Error if malformed request
404	Error	Error if application was not found

Post

Create a new experience user for an application

Method And Url

POST https://api.losant.com/applications/APPLICATION_ID/experience/users

Authentication

A valid API access token is required to access this endpoint. The token must include at least one of the following scopes: all.Application, all.Organization, all.User, experienceUsers.*, or experienceUsers.post.

Request Path Components

Path Component	Description	Example
APPLICATION_ID	ID associated with the application	575ec8687ae143cd83dc4a97

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

{
  "email": "experienceuser@example.com",
  "firstName": "Example",
  "lastName": "Name",
  "password": "aUserPassword",
  "userTags": {
    "customKey": "customValue"
  }
}

Curl Example

curl -H 'Content-Type: application/json' \
    -H 'Accept: application/json' \
    -H 'Authorization: Bearer YOUR_API_ACCESS_TOKEN' \
    -X POST \
    -d '{"email":"experienceuser@example.com","firstName":"Example","lastName":"Name","password":"aUserPassword","userTags":{"customKey":"customValue"}}' \
    https://api.losant.com/applications/APPLICATION_ID/experience/users

Successful Responses

Code	Type	Description
201	Experience User	Successfully created experience user

Error Responses

Code	Type	Description
400	Error	Error if malformed request
404	Error	Error if application was not found

Schemas

Advanced Experience User Query

Schema for advanced experience user queries

Advanced Experience User Query Schema

▶
root:{} 4 keys
$schema:"http://json-schema.org/draft-07/schema#"
type:"object"
▶
properties:{} 13 keys
▶
$and:{} 3 keys
▶
$or:{} 3 keys
▶
$nor:{} 3 keys
▶
id:{} 1 key
▶
creationDate:{} 1 key
▶
lastUpdated:{} 1 key
▶
firstName:{} 1 key
▶
lastName:{} 1 key
▶
email:{} 1 key
▶
lastLogin:{} 1 key
▶
passwordLastUpdated:{} 1 key
▶
userTags:{} 1 key
▶
experienceGroupId:{} 1 key
additionalProperties:false

Advanced Experience User Query Example

▶
root:{} 2 keys
firstName:"Bob"
lastUpdated:"2022-01-30T17:18:11.911Z"

Error

Schema for errors returned by the API

Error Schema

▶
root:{} 3 keys
$schema:"http://json-schema.org/draft-07/schema#"
type:"object"
▶
properties:{} 2 keys
▶
type:{} 1 key
▶
message:{} 1 key

Error Example

▶
root:{} 2 keys
type:"NotFound"
message:"Application was not found"

Experience User

Schema for a single Experience User

Experience User Schema

▶
root:{} 3 keys
$schema:"http://json-schema.org/draft-07/schema#"
type:"object"
▶
properties:{} 14 keys
▶
id:{} 2 keys
▶
experienceUserId:{} 2 keys
▶
applicationId:{} 2 keys
▶
creationDate:{} 2 keys
▶
lastUpdated:{} 2 keys
▶
passwordLastUpdated:{} 2 keys
▶
lastLogin:{} 2 keys
▶
email:{} 3 keys
▶
firstName:{} 2 keys
▶
lastName:{} 2 keys
▶
avatarUrl:{} 3 keys
▶
tokenCutoff:{} 2 keys
▶
userTags:{} 3 keys
▶
experienceGroups:{} 2 keys

Experience User Example

▶
root:{} 12 keys
id:"58b9d782cbfafe1be675744d"
experienceUserId:"58b9d782cbfafe1be675744d"
applicationId:"575ec8687ae143cd83dc4a97"
creationDate:"2016-06-13T04:00:00.000Z"
lastUpdated:"2016-06-13T04:00:00.000Z"
passwordLastUpdated:"2016-06-13T04:00:00.000Z"
lastLogin:"2016-06-13T04:00:00.000Z"
email:"experienceuser@example.com"
firstName:"Example"
lastName:"Name"
avatarUrl:"https://example.avatar.url/is_here.png"
▶
userTags:{} 1 key

Experience User Post

Schema for the body of an Experience User creation request

Experience User Post Schema

▶
root:{} 5 keys
$schema:"http://json-schema.org/draft-07/schema#"
type:"object"
▶
properties:{} 7 keys
▶
email:{} 3 keys
▶
firstName:{} 2 keys
▶
lastName:{} 2 keys
▶
password:{} 3 keys
▶
tokenCutoff:{} 2 keys
▶
userTags:{} 3 keys
▶
experienceGroupIds:{} 3 keys
additionalProperties:false
▶
required:[] 2 items

Experience User Post Example

▶
root:{} 5 keys
email:"experienceuser@example.com"
firstName:"Example"
lastName:"Name"
password:"aUserPassword"
▶
userTags:{} 1 key

Experience Users

Schema for a collection of Experience Users

Experience Users Schema

▶
root:{} 3 keys
$schema:"http://json-schema.org/draft-07/schema#"
type:"object"
▶
properties:{} 11 keys
▶
items:{} 2 keys
▶
count:{} 1 key
▶
totalCount:{} 1 key
▶
perPage:{} 1 key
▶
page:{} 1 key
▶
filter:{} 1 key
▶
filterField:{} 1 key
▶
sortField:{} 1 key
▶
sortDirection:{} 2 keys
▶
applicationId:{} 2 keys
▶
experienceGroupId:{} 2 keys

Experience Users Example

▶
root:{} 8 keys
▶
items:[] 1 item
count:1
totalCount:4
perPage:1
page:0
sortField:"name"
sortDirection:"asc"
applicationId:"575ec8687ae143cd83dc4a97"