Calls without X-API-Key need no key. Calls with it need a paid plan — get a key.
Get an API key
Free tier, no form to fill in. Signing in shares your email address with us — we
store it to create your key and to recognise you if you sign in with another
provider. See our Privacy Policy and
Terms.
openapi: 3.2.0
info:
title: Crawdar Com Lists API
version: 1.10.0
description: 'Operations tagged Lists across 2 of this provider''s published API definitions: crawdar-com-openapi.json, crawdar-com-openapi.yml. Each path carries the servers of the definition it was published in.'
servers:
- url: https://crawdar.com
tags:
- name: Lists
paths:
/api/v1/lists:
get:
operationId: listProspectLists
summary: List this account's persistent prospect lists
security:
- AgentKey: []
- BearerKey: []
responses:
'200':
description: Operation completed.
'401':
description: Verified account required. Sign in at /account or present its API key.
'404':
description: List not found in this account.
tags:
- Lists
post:
operationId: createProspectList
summary: Create a list, up to 100 per account
security:
- AgentKey: []
- BearerKey: []
requestBody:
required: true
content:
application/json:
schema:
type: object
required:
- name
properties:
name:
type: string
minLength: 1
maxLength: 100
responses:
'201':
description: List id and name.
'400':
description: Invalid name or request.
'401':
description: Verified account required. Sign in at /account or present its API key.
'409':
description: Account has reached its list limit.
tags:
- Lists
servers:
- url: https://crawdar.com
/api/v1/lists/{id}:
patch:
operationId: renameProspectList
summary: Rename an account-owned list
security:
- AgentKey: []
- BearerKey: []
parameters:
- name: id
in: path
required: true
schema:
type: string
format: uuid
requestBody:
required: true
content:
application/json:
schema:
type: object
required:
- name
properties:
name:
type: string
minLength: 1
maxLength: 100
responses:
'200':
description: Operation completed.
'400':
description: Invalid name or request.
'401':
description: Verified account required. Sign in at /account or present its API key.
'404':
description: List not found in this account.
tags:
- Lists
delete:
operationId: deleteProspectList
summary: Delete an account-owned list and its saved rows
security:
- AgentKey: []
- BearerKey: []
parameters:
- name: id
in: path
required: true
schema:
type: string
format: uuid
responses:
'200':
description: Operation completed.
'401':
description: Verified account required. Sign in at /account or present its API key.
'404':
description: List not found in this account.
tags:
- Lists
get:
operationId: readProspectList
summary: Read and filter saved prospects
security:
- AgentKey: []
- BearerKey: []
parameters:
- name: id
in: path
required: true
schema:
type: string
format: uuid
- name: q
in: query
schema:
type: string
description: Text filter.
- name: status
in: query
schema:
type: string
description: Prospect status filter, for example qualified or possible.
- name: contact
in: query
schema:
type: string
description: Use yes to retain prospects with a public email or phone.
responses:
'200':
description: Operation completed.
'401':
description: Verified account required. Sign in at /account or present its API key.
'404':
description: List not found in this account.
tags:
- Lists
post:
operationId: importSearchIntoList
summary: Import trusted search results and merge duplicate businesses
description: Up to 1,000 prospects per list. Provide a signed searchToken belonging to this account, or a completed jobId and its private jobToken. Arbitrary client-supplied result rows are not accepted.
security:
- AgentKey: []
- BearerKey: []
parameters:
- name: id
in: path
required: true
schema:
type: string
format: uuid
requestBody:
required: true
content:
application/json:
schema:
type: object
properties:
searchToken:
type: string
jobId:
type: string
format: uuid
jobToken:
type: string
anyOf:
- required:
- searchToken
- required:
- jobId
- jobToken
responses:
'200':
description: Operation completed.
'400':
description: Invalid import or list full.
'401':
description: Verified account required. Sign in at /account or present its API key.
'404':
description: List not found in this account.
'409':
description: Search has not completed.
'410':
description: Signed search expired or belongs to a different identity.
tags:
- Lists
servers:
- url: https://crawdar.com
/api/v1/lists/{id}/refresh:
post:
operationId: refreshProspectList
summary: Refresh one due prospect using the normal search allowance
description: Checks evidence older than seven days. Reports changedFields on a match; preserves previous evidence and observation date if no current match is found. Call again to process remaining due prospects.
security:
- AgentKey: []
- BearerKey: []
parameters:
- name: id
in: path
required: true
schema:
type: string
format: uuid
responses:
'200':
description: Operation completed.
'401':
description: Verified account required. Sign in at /account or present its API key.
'404':
description: List not found in this account.
'409':
description: Prospect is already being refreshed.
'429':
description: Search allowance or provider capacity reached. Honor Retry-After.
headers:
x-request-id:
schema:
type: string
ratelimit-limit:
schema:
type: integer
ratelimit-remaining:
schema:
type: integer
ratelimit-reset:
schema:
type: integer
description: Seconds until reset.
tags:
- Lists
servers:
- url: https://crawdar.com
/api/v1/lists/{id}/export:
get:
operationId: exportProspectList
summary: Export filtered prospect evidence as CSV for CRM import
security:
- AgentKey: []
- BearerKey: []
parameters:
- name: id
in: path
required: true
schema:
type: string
format: uuid
- name: q
in: query
schema:
type: string
description: Text filter.
- name: status
in: query
schema:
type: string
description: Prospect status filter, for example qualified or possible.
- name: contact
in: query
schema:
type: string
description: Use yes to retain prospects with a public email or phone.
responses:
'200':
description: CSV download with source URLs and observation dates.
content:
text/csv:
schema:
type: string
'401':
description: Verified account required. Sign in at /account or present its API key.
'404':
description: List not found in this account.
tags:
- Lists
servers:
- url: https://crawdar.com
components:
securitySchemes:
AgentKey:
type: apiKey
in: header
name: x-api-key
description: Account key created while signed in at /account; all keys share account limits.
BearerKey:
type: http
scheme: bearer
description: 'The same account API key may be sent as Authorization: Bearer YOUR_KEY.'
JobToken:
type: apiKey
in: header
name: x-job-token
description: Capability token returned once with a search job.
x-refined-from:
- crawdar-com-openapi.json
- crawdar-com-openapi.yml