Clear API Reference
Homepage
User Documentation
Search…
Developer Reference
Getting Started
Guides
Experience API Reference
Statements
State
Activity Profile
Agent Profile
Clear API Reference
Introduction
Data Model
Authentication
Actors
Reports
Leaderboards
Search
Notifications
Import
Powered By
GitBook
Actors
get
https://{organisation}.clearlrs.com
/api/actors
List Actors
put
https://{organisation}.clearlrs.com
/api/actors/agents
Insert/Update Agent
post
https://{organisation}.clearlrs.com
/api/actors/search
Search Actors
Search Criteria
The actor search endpoint allows for defining a complex search criteria. The most basic request body might look like the following:
1
{
2
criteria
:
{
3
"="
:
[
4
{
type
:
"name"
},
5
"Stephen Smith"
6
]
7
}
8
}
Copied!
A more complex example can include nested conditions:
1
{
2
criteria
:
{
3
and
:
[
4
{
"="
:
[
5
{
type
:
"attribute"
,
key
:
"Country"
},
6
"AU"
7
]
},
8
{
or
:
[
9
{
"="
:
[
10
{
type
:
"attribute"
,
key
:
"Department"
},
11
"Marketing"
12
]
},
13
{
"!="
:
[
14
{
type
:
"attribute"
,
key
:
"Job Title"
},
15
"*Manager"
16
]
}
17
]
}
18
]
19
}
20
}
Copied!
get
https://{organisation}.clearlrs.com
/api/actors/attributes
List Attributes
get
https://{organisation}.clearlrs.com
/api/actors/completions
Get Completion Records
Clear API Reference - Previous
Authentication
Next - Clear API Reference
Reports
Last modified
10mo ago
Copy link
Contents
get
List Actors
put
Insert/Update Agent
post
Search Actors
get
List Attributes
get
Get Completion Records