Skip to main content

Documentation Index

Fetch the complete documentation index at: https://docs.seamless.ai/llms.txt

Use this file to discover all available pages before exploring further.

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:
https://docs.seamless.ai/openapi.json
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:
VariableValue
baseUrlhttps://api.seamless.ai/api/client/v1
apiKeyYour API key from Settings → Public API
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.

​
Runnable flow in Postman

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

Search contacts

POST /search/contacts
{
  "jobTitle": ["Chief Technology Officer"],
  "companyName": ["Acme Corp"],
  "limit": 5
}
Copy data[0].searchResultId from the response.
2

Research contacts

POST /contacts/research
{
  "searchResultIds": ["PASTE_SEARCH_RESULT_ID"]
}
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, missing, or (contacts only) duplicate.

​
Environment template

Create a Postman environment with these variables: 
{
  "baseUrl": "https://api.seamless.ai/api/client/v1",
  "apiKey": "",
  "searchResultId": "",
  "requestId": ""
}
Use Postman’s Tests tab on the search request to auto-save IDs: 
const body = pm.response.json();
if (body.data && body.data[0]) {
  pm.environment.set("searchResultId", body.data[0].searchResultId);
}
On the research request: 
const body = pm.response.json();
if (body.requestIds && body.requestIds[0]) {
  pm.environment.set("requestId", body.requestIds[0]);
}

​
Next steps