hornet icon

hornet

Interact with hornet API

Actions452

Service Dashboard → Service Dashboard Search Post

AI-generated

Summary

Searches the Service Dashboard via a POST request using the supplied filter criteria.

Inputs

  • object_id (required) — The ID of an object (user, customer, or partner). Sent as a query parameter.
  • APP-ID (required) — Your application identifier issued by the service. Sent as a request header.
  • query — Search term used to filter results. Sent in the request body as a string.
  • date_from — Start of the date/time period in ISO-8601 UTC. Must be earlier than date_to. Sent in the request body.
  • date_to — End of the date/time period in ISO-8601 UTC. If set to a future date, the current date/time is used. Sent in the request body.
  • included_in_filtering_fields — Array of fields selected for filtering by the query parameter. Sent in the request body as JSON.
  • is_discovered_via_mpc — When true, only customers discovered via MPC are returned; when false, only manually onboarded customers (including TP-related) are returned. Sent in the request body as a boolean. Default: true.
  • customer_type — Customer type(s) used to filter results. Sent in the request body as JSON.
  • page — Page number for paginated results. Sent in the request body as a number. Default: 0.
  • limit — Maximum number of results to return. Sent in the request body as a number. Default: 0.
  • key — Field by which results are ordered. Sent in the request body as a string.
  • order — Sort direction, e.g., 'asc' or 'desc'. Sent in the request body as a string.
  • include_only_tenant_management — When true, only returns customers that have a tenant_id set for tenant management. Sent in the request body as a boolean. Default: true.

Output shape

The JSON response from the Service Dashboard search endpoint, containing the filtered result set.

The exact structure depends on the API but is passed through unchanged to the workflow.

Examples

Example 1: Search for customers discovered via MPC within a date range, limited to 20 items.

Set object_id, APP-ID, provide query string, set date_from and date_to, ensure is_discovered_via_mpc is true, set limit to 20.

Links

Discussion