Companies

Get bulk-delivery job status for companies

GET
/v1/companies/bulk-delivery/{jobId}

Authorization

x-api-key<token>

In: header

Path Parameters

jobId*string

Job ID returned by POST /v1/companies/bulk-delivery

Response Body

application/json

application/json

application/json

application/json

curl -X GET "https://example.com/v1/companies/bulk-delivery/string"
{
  "bytes": 0,
  "chargedCount": 0,
  "completedAt": "string",
  "creditLedgerId": "string",
  "creditsCharged": 0,
  "downloadUrl": "string",
  "entityType": "string",
  "error": "string",
  "estimatedTotal": 0,
  "format": "parquet",
  "jobId": "string",
  "processed": 0,
  "resultsUrl": "string",
  "startedAt": "string",
  "status": "queued"
}
{
  "error": "string"
}
{
  "error": "string"
}
{
  "error": "string"
}

Count companies matching filters POST

Return the exact number of companies matching the given filters. Accepts the same request body as `listCompanies` (pagination and sort are ignored). Use this when you only need a total; to get the matching companies themselves, send the same request body to `listCompanies`.

Get company by NMLS ID GET

Next Page