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:
{
    criteria: {
        "=": [
            { type: "name" },
            "Stephen Smith"
        ]
    }
}
A more complex example can include nested conditions:
{
    criteria: {
        and: [
            { "=": [
                { type: "attribute", key: "Country" },
                "AU"
            ] },
            { or: [
                { "=": [
                    { type: "attribute", key: "Department" },
                    "Marketing"
                ] },
                { "!=": [
                    { type: "attribute", key: "Job Title" },
                    "*Manager"
                ] }
            ] }
        ]
    }
}
get
https://{organisation}.clearlrs.com
/api/actors/attributes
List Attributes
get
https://{organisation}.clearlrs.com
/api/actors/completions
Get Completion Records

Last modified 1yr ago