Skip to content

List all connections on specified entity

GET https://api.prosperworks.com/developer_api/v1/related_links?source_type={{source_type}}&source_id={{source_id}}

To retrieve already existing connections in the connect field, use the list the connections API.

Parameters

You can include the following parameters in a search request.

Key Value Description
source_type {{source_type}} The entity type of the source. Supported sources: "people", "opportunity", "lead", "company", "project", "user"
source_id {{source_id}} The Copper record id for the specified entity type

Example Requests

List the connections on specified entity

1
2
3
4
5
curl --request GET "https://api.prosperworks.com/developer_api/v1/related_links?source_type=people&source_id=155" \
  --header "X-PW-AccessToken: YOUR_TOKEN_HERE" \
  --header "X-PW-Application: developer_api" \
  --header "X-PW-UserEmail: YOUR_EMAIL_HERE" \
  --header "Content-Type: application/json"
 1
 2
 3
 4
 5
 6
 7
 8
 9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
[
    {
        "id": 375,
        "custom_field_definition_id": 172,
        "source": {
            "id": 1021,
            "entity_type": "people",
            "name": "1021"
        },
        "target": {
            "id": 155,
            "entity_type": "user",
            "name": "deque deque"
        }
    },
    {
        "id": 376,
        "custom_field_definition_id": 173,
        "source": {
            "id": 1021,
            "entity_type": "people",
            "name": "1021"
        },
        "target": {
            "id": 156,
            "entity_type": "user",
            "name": "reque reque"
        }
    }
]