SourceListItem

A source the caller has created. Only sources whose type this API supports are listed.

Properties

source_instance_idstringrequired

Source instance UUID — pass to `POST /api/v1/sources/{source_instance_id}/sync` or `GET /api/v1/sources/{source_instance_id}/data`.

namestringrequired

Display name given at creation.

source_idstringrequired

Public source-type slug (e.g. `import_from_hubspot`, `find_companies`) — the identifier used by preview / create / options.

statusstring

Source status: `active` (live, re-importing), `completed` (one-time import, won't refresh), `paused`, `paused_out_of_credits`, `expired`, or `deleted`.

lead_countinteger (nullable)

Rows imported so far.

created_atstring <date-time>

UTC creation timestamp.

expiration_datestring (nullable)

When an active source stops firing.

Example

SourceListItem example

{
  "source_instance_id": "string",
  "name": "string",
  "source_id": "string",
  "status": "string",
  "lead_count": 0,
  "created_at": "1970-01-01T00:00:00.000Z",
  "expiration_date": "string"
}