Bulk Retrieval API

The Bulk Retrieval API provides programmatic access to enrichment data stored in Kernel.

Unlike the Inbound API which handles asynchronous enrichment workflows, the Bulk API provides direct retrieval of already-enriched data.

Authentication

Please contact your Kernel representative to request a token for API access.

Token Expiration: Tokens are valid for 7 days from the time of creation. After expiration, you will need to request a new token.

Pagination

The API supports pagination to handle large datasets efficiently:

  • page: Page number (0-indexed). Default: 0

  • pageSize: Records per page (max 1,000). Default: 1,000

  • Response includes pagination metadata with total records, total pages, and navigation info

Response Format

The response is a JSON object containing:

  • data: Array of enrichment records, each with an "Id" field (Salesforce ID) and dynamic fields based on your configuration

  • pagination: Metadata including page, pageSize, totalRecords, totalPages, and hasNextPage

The exact fields returned depend on your specific configuration. Contact your Kernel representative for details on your field mappings.

Rate Limits

The API enforces rate limiting to ensure fair usage:

  • Rate Limit: 5 requests per second per token

  • 429 Response: When rate limit is exceeded, you'll receive a 429 status code. Please wait before retrying.

Error Handling

  • 401 Unauthorized: Invalid or expired token

  • 400 Bad Request: Missing or invalid query parameters

  • 500 Internal Server Error: Server-side error occurred

Retrieve enrichment data

get

Retrieve enrichment data for your organization using token-based authentication.

The response is paginated and contains only the fields configured in your bulk API setup. The structure is dynamic and depends on your specific field mappings.

Use the page and pageSize query parameters to navigate through large datasets. The response includes pagination metadata to help you iterate through all pages.

Query parameters
tokenstringRequired

Authentication token for bulk API access

Example: abc123xyz789
pageinteger · max: 9007199254740991Optional

Page number for pagination (0-indexed)

Default: 0Example: 0
pageSizeinteger · max: 1000Optional

Number of records per page (max 1000)

Default: 1000Example: 1000
Responses
200

Enrichment data retrieved successfully. Returns a paginated response with data array and pagination metadata.

application/json
get
/api/v1/bulk/retrieval
GET /api/v1/bulk/retrieval?token=abc123xyz789 HTTP/1.1
Host: 
Accept: */*

{
  "data": [
    {
      "Id": "001j000000HWb16AAD",
      "Kernel_Company_Name__c": "Acme Corporation",
      "Kernel_Website_status__c": "Working",
      "Kernel_Headcount": 150,
      "Kernel_Country__c": "United States",
      "Kernel_Industry__c": "Software",
      "Kernel_Cleaned_website__c": "acme.com",
      "Kernel_Parent_company__c": null,
      "Kernel_Is_website_working__c": true
    },
    {
      "Id": "001j000000HWb17AAD",
      "Kernel_Company_Name__c": "Beta Inc",
      "Kernel_Website_status__c": "Working",
      "Kernel_Headcount": 250,
      "Kernel_Country__c": "Canada",
      "Kernel_Industry__c": "Technology",
      "Kernel_Cleaned_website__c": "beta.com",
      "Kernel_Parent_company__c": null,
      "Kernel_Is_website_working__c": true
    }
  ],
  "pagination": {
    "page": 0,
    "pageSize": 1000,
    "totalRecords": 5432,
    "totalPages": 6,
    "hasNextPage": true
  }
}
PreviousInbound API

Last updated