Skip to main content
Postman is the fastest way to explore the REST API without writing a script. Import the same OpenAPI document that powers the API Reference tab.

​
Prerequisites

  • A Seamless account with Public API access
  • An API key
  • Postman installed

​
Import the collection

1

Get the OpenAPI URL

Use the production OpenAPI spec:
2

Import into Postman

In Postman, click Import → Link, paste the OpenAPI URL, and confirm.
3

Set the API key

Open the collection Variables (or each request) and set:For each request, add header: Token: {{apiKey}}.
OAuth apps should use the Get an access token request, then set Authorization: Bearer {{ accessToken }} on other requests instead of the Token header.

​
v2 collection

Public API v2 is in beta and most of its endpoints are not in the OpenAPI document. To try v2, download the ready-made v2 Postman collection, import it with Import → File, and set its api_token variable to your API key. It covers every v2 endpoint, including engagement and account routes, and sends your key as the Token header automatically.

​
Runnable flow in Postman

Run these requests in order. Copy IDs from each response into the next request.
1

Search contacts

POST /search/contacts
Copy data[0].searchResultId from the response.
2

Research contacts

POST /contacts/research
Copy requestIds[0] from the response.
3

Poll until done

GET /contacts/research/poll?requestIds=PASTE_REQUEST_IDSend every 3–5 seconds until data[0].status is done, error, or (contacts only) not found or duplicate. For contacts, missing means the requestId is unknown; for companies it means the request has not finished yet.

​
Environment template

Create a Postman environment with these variables:
Use Postman’s Tests tab on the search request to auto-save IDs:
On the research request:

​
Next steps