Searching for boxes, contacts, and organizations by query

get https://api.streak.com/api/v1/search?query={query}

Any search by query will return results on orgs, boxes, and contacts.

time	status	user agent
Retrieving recent requests…

Loading…

Boxes

The search endpoint allows you to search the contents on boxes. The search functionality returns a relevance sorted list of boxes. query will return a search on name, notes, emails, text formula custom fields, and text freeform custom fields.

Boxes come back in the following format:

Property Name	Description
`boxKey`	The key of the box found
`name`	Name of the box found
`lastUpdatedTimestamp`	Timestamp of the last time the box was updated
`assignedToKeys`	List of the keys of users assigned to the box
`pipelineKey`	Key of the pipeline the box is in
`stageKey`	Stage the box is in

Below is an example of a request that limits search to 2 pipelines and three stages. Replace the {{double brackets}} and the text within to use the request yourself.

curl 'https://api.streak.com/api/v1/search?query={{Everything+is+awesome%21}}&pipelineKey={{agxaWmb29nE9yRyZXb3JrXCgw}}&pipelineKey={{agb29nYaXphdGlvb3JrZmxv}}&stageKey={{5003}}&stageKey={{5005}}&stageKey={{5007}}' -u {{YOUR API KEY}}:

Responses

Language

Credentials

Basic

base64


xxxxxxxxxx
1
curl --request GET \
2
     --url 'https://api.streak.com/api/v1/search?query=query' \
3
     --header 'Content-Type: application/json' \
4
     --header 'accept: application/json'

Click Try It! to start a request and see the response here! Or choose an example:

application/json

Boxes

200200

400400