External DocumentationTo learn more, visit the Cognism documentation.
Basic Parameters
| Parameter | Description |
|---|---|
| Account Description | An account description (keyword) to filter results by. |
| Account Domains | A comma-separated list of account domains to filter results by. |
| Account IDs | A comma-separated list of account IDs to filter results by. |
| Account Keywords | A comma-separated list of account keywords to filter results by. |
| Account Names | A comma-separated list of account names to filter results by. |
| Account Short Description | An account short description (keyword) to filter results by. |
| Account Types | Account types to filter the retrieved results by. |
| Account Websites | A comma-separated list of account websites to filter results by. |
| Exclude Account Description | Exclude all accounts whose descriptions contain any keyword specified in the provided string. |
| Exclude Account Domains | A comma-separated list of account domains to exclude from the retrieved results. |
| Exclude Account Names | A comma-separated list of account names to exclude from the retrieved results. |
| Page | The page number to retrieve. Starts from 0. |
| Per Page | The maximum number of results to retrieve per page. Valid range is 1 - 100. |
| Return All Pages | Automatically fetch all resources, page by page. |
Advanced Parameters
| Parameter | Description |
|---|---|
| Additional Parameters | A JSON object for additional body parameters. Values specified in this parameter will override equivalent parameters. For example: |
Example Output
{
"lastReturnedKey": "efc6d975-8599-38ab-8cfe-e1c42ac16dc6",
"totalResults": 1,
"results": [
{
"id": "efc6d975-8599-38ab-8cfe-e1c42ac16dc6",
"name": "Cognism",
"hasDomain": true,
"hasIndustries": true,
"hasDescription": true,
"hasShortDescription": true,
"hasFounded": true,
"hasWebsite": true,
"hasLinkedinUrl": true,
"hasRevenue": true,
"hasDepartment": true,
"hasSic": true,
"hasIsic": false,
"hasNaics": true,
"hasSize": true,
"hasHeadcount": true,
"hasTechnologies": true,
"hasType": true,
"hasCountry": true,
"hasState": true,
"hasCity": true,
"hasZip": true,
"hasStreet": true,
"hasOfficePhoneNumbers": false,
"hasHqPhoneNumbers": true,
"hasHiringEvent": false
}
]
}