Search

Global search across workspace content.

Endpoints

Endpoint	Arguments	Returns
v2.search.global	options	object

v2.search.global

Description

Undocumented

This endpoint has no description in the source yet.

Parameters

Argument 1 (object, optional):

Field	Type	Required	Description
search	string	yes
sections	activities | events | files | users | feed | messages[]	yes
discussionId	any	no
options	object	no

Example

const { Client } = require('@hailer/cli');

const client = await Client.create({
  host: 'https://api.hailer.com',
  username: 'you@example.com',
  password: '••••••',
});

const result = await client.request('v2.search.global', [
  {
    search: 'string',
    sections: ['activities'],
  },
]);
console.log(result);

Returns

Field	Type	Required	Description
feed	any[]	yes
activities	object[]	yes
users	any[]	yes
events	any[]	yes
messages	object[]	no
files	any[]	yes

Auth: requires an authenticated session.

Errors: on failure returns the standard Hailer error object { code, msg, details?, debug? }.