STstreakyc
Search

Search boxes, contacts, and organizations

Changed on

Searches visible boxes, contacts, and organizations by query, or visible boxes by exact name. Exactly one of query or name must be provided.

get/v1/search

Request

  • Base URL
    https://api.streak.com/api
  • URL
    https://api.streak.com/api/v1/search
  • Auth
    HTTP bearer

Query parameters

namestring nullable

Exact box name to search for.

pageinteger

Zero-based page number.

pipelineKeystring[] nullable

Pipeline keys to constrain the search to.

querystring nullable

Full-text query to search across boxes, contacts, and organizations.

stageKeystring[] nullable

Stage keys to constrain the search to.

teamKeystring[] nullable

Team keys to constrain the search to.

Response

OK

querystring nullable

The query string used for full-text searches. Null when searching by exact box name.

pageinteger

Zero-based page number returned by the search.

Changes