AdhocSearch

Get objects by ID and graph link rules, returning a query ID for slow results

Returns objects from the given IDs and links given with the graph rules. If no rules are present, returns only the objects with the given IDs. If results are slow to fetch, part of the results will be returned with a query ID that can be used to fetch the remaining results from poll_results.

  • Requires action source_data:Query
post/api/v1/org/{orgUID}/objects/start_query

Request

  • Base URL: https://api.prod.spyderbat.com
  • URL: https://api.prod.spyderbat.com/api/v1/org/{orgUID}/objects/start_query
  • Auth: HTTP bearer

Path parameters

orgUIDstring required

Organization UID to query

Request body

context_uidstring

Context UID for this query, it's used to track the query as it flows through the system, and shouldn't be exposed to customers

idsstring[] required

Array of IDs to resolve into records

Response

OK

query_idstring

Optional ID that can be passed to poll results to get the rest of the results

Changes

No recorded changes to this operation across all 1 revision of this API.