Search

POST /v1/searches

Changed on

Starts a search.

Request

  • Base URL
    https://usefind.ai/found
  • Auth
    API key in header Authorization

Request body

querystring

Search query.

scope'person' | 'company'

The scope of the search. Valid values are 'person' or 'company'.

result_mode'exact' | 'best'

The mode of the search. Valid values are 'exact' or 'best'.

max_matchesnumber

The maximum number of results to return. optional for result_mode exact

Response

Search has been started. Poll based on the details in the response for the status and latest information.

Changes

    • breaking

      request property was restricted to a list of enum values

    • breaking

      request property was restricted to a list of enum values

    • info

      added the new best enum value to the request property

    • info

      added the new company enum value to the request property

    • info

      added the new exact enum value to the request property

    • info

      added the new person enum value to the request property

    • breaking

      removed the media type */* for the response with the status

    • breaking

      removed the media type */* for the response with the status

    • info

      added the media type application/json for the response with the status

    • info

      added the media type application/json for the response with the status