Seamless
Provides integration with Seamless Public API v1 for searching, reading, submitting research, and polling enrichment results.
Revision History
0.0.0.4 - Initial release.
Connection
Use a Seamless Connection with either API key authentication or OAuth authentication.
| Property | Type | Description |
|---|---|---|
Authorization Type |
SeamlessAuthorizationType | Selects whether the Connection uses API key authentication or OAuth authentication. |
API Key |
Masked | The Seamless API key sent in the Token header. This is used when Authorization Type is ApiKey. |
Client ID |
String | The Seamless OAuth client identifier. This is used when Authorization Type is OAuth. |
Client Secret |
Masked | The Seamless OAuth client secret. This is used when Authorization Type is OAuth. |
Access Token |
Masked | The OAuth bearer token used for Seamless API requests. This is populated after OAuth authentication. |
Refresh Token |
Masked | The OAuth refresh token used to renew the access token. |
Access Token Expires At UTC |
String | The UTC expiry timestamp used to refresh the OAuth access token before it expires. |
Scope |
String | The Seamless OAuth scope to request. The default is publicAPI.v1.all. |
Timeout (seconds) |
Integer | The timeout used for Seamless OAuth and API calls. The default is 30. |
Setup Notes
Create a Seamless API key or OAuth application before configuring the Connection.
- For API key authentication, set
Authorization TypetoApiKeyand enter the provider-issuedAPI Key. - For OAuth authentication, set
Authorization TypetoOAuth, enter theClient IDandClient Secret, and complete the OAuth authentication flow. - OAuth Connections request the
publicAPI.v1.allscope by default. - The
Connectiontest performs a small company search againstseamless.aito verify the credentials.
Methods
Seamless exposes curated templates for each method. Select a template to populate OperationId, Options, and any available sample values.
Query
Executes supported Seamless search and organization-read operations. Use Query to search company or contact candidates, or to read companies and contacts already available in the connected Seamless organization.
Available templates:
Search companiesSearch contactsGet org companiesGet org contacts
| Parameter | Type | Description |
|---|---|---|
Connection |
Connection | The Seamless Connection. |
OperationId |
String | The stable identifier of the selected Seamless operation. Templates populate this value. |
Options |
Object | Structured options for the selected Seamless query operation. |
| Return | Type | Description |
|---|---|---|
Response |
Array | One response row per company or contact returned by Seamless. |
Research
Submits supported Seamless enrichment requests. Use Research after a search when you need to request full company or contact research results.
Research operations can consume Seamless credits.
Available templates:
Research companiesResearch contacts
| Parameter | Type | Description |
|---|---|---|
Connection |
Connection | The Seamless Connection. |
OperationId |
String | The stable identifier of the selected Seamless research operation. Templates populate this value. |
Options |
Object | Structured options for the selected Seamless research operation. |
Items |
Array | Streamed research identifiers or direct enrichment items for the request body. |
| Return | Type | Description |
|---|---|---|
Response |
Array | One response row per research request ID returned by Seamless. |
Poll
Polls supported Seamless research requests. Use Poll with request IDs returned by Research to retrieve company or contact research status and results.
Available templates:
Poll company researchPoll contact research
| Parameter | Type | Description |
|---|---|---|
Connection |
Connection | The Seamless Connection. |
OperationId |
String | The stable identifier of the selected Seamless poll operation. Templates populate this value. |
Options |
Object | Structured poll options, including RequestIds. |
| Return | Type | Description |
|---|---|---|
Response |
Array | One response row per polled request status returned by Seamless. |
Usage Notes
Querysearch operations page through Seamless results internally with a hidden page size of100.Get org companiesandGet org contactsrequireOptions.startDateandOptions.endDate.- Organization-read operations page internally with a hidden page size of
100and stop when Seamless returns fewer than100rows for a page. - Template fields backed by provider arrays of strings or integers are shown as comma-separated strings, e.g.
companyOne.com, companyTwo.com. - For company research, provide at least one of
searchResultIdsorcompanies. - For contact research, provide exactly one of
searchResultIdsorcontacts. PollrequiresOptions.RequestIdswith at least one request ID.- Each response row includes a
Flowgearobject withIsSuccessand, when available,Message. - Each response row includes a
Seamlessobject with metadata such asHttpStatusCode,ProviderCode,ProviderMessage, andSupplementalDatawhen Seamless returns it.