Quick-search users

GET

/omnisearch/users

const url = 'https://work.optidata.cloud/api/omnisearch/users?query=jane';
const options = {method: 'GET', headers: {Authorization: 'Bearer <token>'}};

try {
  const response = await fetch(url, options);
  const data = await response.json();
  console.log(data);
} catch (error) {
  console.error(error);
}

curl --request GET \
  --url 'https://work.optidata.cloud/api/omnisearch/users?query=jane' \
  --header 'Authorization: Bearer <token>'

Up to ten active users whose name or e-mail contains query, ordered by name. An empty or missing query returns an empty list rather than every user.

Authorizations

bearerAuth

Parameters

Query Parameters

query

string

Text matched against the user’s name and e-mail.

Example

jane

Responses

200

Matching users.

application/json

Array<object>

object

uuid

string format: uuid

name

string

email

string format: email

Examples

matches

[
  {
    "uuid": "9c1f0e2a-4d31-4d8a-8c1a-1f0b6b1f9a10",
    "name": "Jane Doe",
    "email": "jane.doe@acme.example"
  }
]

401

Missing, malformed or expired authentication key.

application/json

Authentication failures use an error key rather than message.

object

error

required

string

Examples

missing

No bearer token sent

{
  "error": "JWT passport exception: Missing bearer token in request"
}

429

Rate limit exceeded. Retry after the window resets.

application/json

Generic error envelope used by policy, binding and framework failures.

object

message

required

Human-readable description of the failure.

string

Examples

throttled

{
  "message": "Too Many Attempts."
}