Clear API Reference
  • Developer Reference
  • Getting Started
    • Authentication
    • Content Launch
    • Single Sign-On
  • Guides
    • Account Provisioning and Launch
  • Experience API Reference
    • Statements
    • State
    • Activity Profile
    • Agent Profile
  • Clear API Reference
    • Introduction
    • Data Model
      • Actor
      • Criteria
    • Authentication
    • Actors
    • Reports
    • Leaderboards
    • Search
    • Notifications
    • Import
Powered by GitBook
On this page
  1. Clear API Reference

Search

PreviousLeaderboardsNextNotifications

Last updated 2 years ago

Search Resources

GET https://{organisation}.clearlrs.com/api/search

Advanced system-wide search across multiple resources. The results of this search will include both Actors (Agents and Groups) as well as Activities.

Query Parameters

Name
Type
Description

limit

number

Limits the number of results returned

skip

boolean

Skips over this number of items in query results

Headers

Name
Type
Description

Accept-Version

string

Set to 2.0.0 to use this version of the API

Request Body

Name
Type
Description

criteria

object

A Search Criteria object as described below

Search Criteria

Please see the

Criteria Documentation