Skip to main content
GET
List a contact's documents
Lists every document on a contact: the processed CV, completed uploads, and uploads that have not been completed yet.

Overview

A contact’s documents are what an agent can look up about the specific person it is calling — their CV, a cover letter, application notes. They live in the same knowledge base machinery as an agent’s documents, and the response has the same shape, with one addition: source. limit is the per-contact cap on uploaded documents (5). The CV document does not count towards it.

Whether a document reaches a call

Listing a document does not mean an agent will see it. One switch decides: the agent has contextConfig.useContactContext enabled — the agent author’s intent to draw on what the platform knows about the person it is calling. With it on, the contact’s active documents are attached to the call as the candidate knowledge base, and the agent’s prompt gains one sentence telling it the documents exist and may be looked up — never read aloud. With it off, the call runs exactly as it did before, documents or not.

Example

The CV document’s fileName is the name of the file that was uploaded for processing; what the agent can look up is the anonymized text of that CV — names, contact details and employer names replaced with generic terms — not the original file, which InstaView does not keep.

Error Scenarios

  • 404 Not Found: No contact with that id belongs to your API key’s company

Authorizations

Authorization
string
header
required

API key for authentication using Bearer scheme

Path Parameters

id
string<uuid>
required

Contact the documents belong to.

Query Parameters

companyId
string

Required for ATS API keys to specify which company to access. Ignored for standard company API keys.

Response

Documents on the contact, oldest first. limit is the per-contact upload cap (5); the CV document does not count towards it.

data
object[]
required

Documents attached to the agent or contact, oldest first

total
number
required

Number of documents attached

Example:

3

limit
number
required

Maximum uploaded documents the resource may hold: 10 for an agent, 5 for a contact. A contact's CV document does not count towards it.

Example:

10