Common Use Cases

This page contains sequence diagrams, API references, and sample data for common use cases of Live Data, including:

Use this flow to automate contact imports into the API. This is best used for small batches of imports up to a few hundred. For larger batch imports, CSV upload via the UI is preferred.

• User has at least editor role
• Ledger has been created

1. Client calls create contact API providing name and company at a minimum. When provided, linkedin is treated as authoritative. An optional referenceId can be provided to reference this contact in the client’s system. The referenceId must be unique - duplicates are rejected during import. The name provided is never modified by Live Data.
2. Live Data replies with information about the import job - an import is created every time contacts are added.
3. (optional) Client polls import job endpoint to get status of the import

sequenceDiagram
    autonumber
    participant Client
    participant LiveData
    Client->>LiveData: POST /contacts
    LiveData->>Client: import job ID
    Client->>LiveData: GET /imports job status

• User has at least viewer role
• Ledger has been created

1. Client calls get contacts API with any desired filters, most often using the lastJobChangedAt or lastInfoChangedAt filter to only return contacts updated since a certain time. The download endpoint can be used with the same filters to return the data in CSV form.
2. Live Data returns all contact objects that meet the filter criteria.
3. Client repeats this process on a duration of their choosing.

sequenceDiagram
    autonumber
    participant Client
    participant LiveData
    loop as needed
        Client->>LiveData: GET /contacts
        LiveData->>Client: list of matching contacts
    end