List all secondary contacts

Lists links between contacts and deals, 20 per page by default and up to 100 per page (limit). By default only secondary contacts are listed: a link for the deal's primary contact, and a link whose deal no longer exists, are left out. Send include_primary_contact=1 to also list primary contacts, with each deal's primary contact first. Narrow the list with filters[deal] and filters[contact], which match exactly. The order of the other links is not guaranteed. lastContactDate and lastContactType are added when the contact has had a qualifying activity. Only one link per contact on the page carries them; the contact's other links leave them out. Needs the deals permission. For one contact's links use GET /contacts/{id}/contactDeals; for one deal's links use GET /deals/{id}/contactDeals.

To retrieve all secondary contacts, the user should have permission to manage deals.

{
    "contactDeals": [
        {
            "deal": "2",
            "contact": "1",
            "cdate": "2019-02-25T08:16:56-06:00",
            "links": {
                "deal": "/api/3/contactDeals/1/deal",
                "contact": "/api/3/contactDeals/1/contact"
            },
            "id": "1"
        }
    ],
    "meta": {
        "total": "1"
    }
}
Query Params
integer

Only links to this deal id.

integer

Only links for this contact id.

integer
enum

Send 1 to also list each deal's primary contact, sorted first. Without it, primary contacts are left out.

Allowed:
integer

Number of links per page. Default 20, maximum 100.

integer

Number of links to skip before the page starts. Default 0.

string

Comma-separated link ids to fetch. Overrides limit; offset still applies.

Responses

Language
Credentials
Header
URL
LoadingLoading…
Response
Choose an example:
application/json