List the connections on specified entity for a specific custom-field-definition-id¶
GET https://api.copper.com/developer_api/v1/related_links?custom_field_definition_id={{custom_field_definition_id}}&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 |
---|---|---|
custom_field_definition_id | {{custom_field_definition_id}} | The Id of the custom field definition. This can be fetched by the custom_field_definitions API. |
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.copper.com/developer_api/v1/related_links?custom_field_definition_id=178&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 | [ { "id": 375, "custom_field_definition_id": 172, "source": { "id": 1021, "entity_type": "people", "name": "1021" }, "target": { "id": 155, "entity_type": "user", "name": "deque deque" } } ] |