Search API Quick Start
In order to consume Sell Search API a valid token is required. For information on obtaining this token from your account, go to our Authentication Section.
Note that the account used to generate the token must have the right plan enabled. Consult our pricing page for information on which plans support Search API access.
Permissions
Requests in Search API are executed in context of particular user (recognized by the token) and his/her permissions. So Search API responses will only contain subsets of all account data, that the token owner has access to.
Endpoints
There are 11 endpoints within Search API:
| Endpoint | Action | Request payload | Response payload | Description |
|---|---|---|---|---|
/v3/deals/schema | GET | - | YAML | Yaml schema of deals (attributes, types, sort and filter properties) |
/v3/leads/schema | GET | - | YAML | Yaml schema of leads (attributes, types, sort and filter properties) |
/v3/contacts/schema | GET | - | YAML | Yaml schema of contacts (attributes, types, sort and filter properties) |
/v3/graphql/schema | GET | - | graphqls | GraphQL schema of GraphQL Search API (currently only supports companies query) |
/v3/search-schema | GET | - | JSON | JSON schema of Search API request |
/v3/deals/search | POST | JSON with Query language request | JSON response of the api (see response format) | Search endpoint for deals |
/v3/leads/search | POST | JSON with Query language request | JSON response of the api (see response format) | Search endpoint for leads |
/v3/contacts/search | POST | JSON with Query language request | JSON response of the api (see response format) | Search endpoint for contacts |
/v3/notes/search | POST | JSON with Query language request | JSON response of the api (see response format) | Search endpoint for notes |
/v3/tasks/search | POST | JSON with Query language request | JSON response of the api (see response format) | Search endpoint for tasks |
/v3/graphql | POST | graphql request | JSON as per GraphQL specification | GraphQL API endpoint for querying companies data (with company hierarchy information) |
Additionally, there's GraphiQL viewer available (requires logging to your Sell account):
https://app.futuresimple.com/apis/views/graphiql
Sending requests
After you've obtained valid API token, you can start sending HTTP requests,
e.g. via cURL, software like Postman or programatically:
Accessing Search API
curl -XPOST -H "Authorization: Bearer $TOKEN" -H 'Content-Type: application/json' -d'{"items":[{"data":{}}]}' https://api.getbase.com/v3/deals/search