List people
People (contacts) matching a name or email, with company and Contact Type.
GET https://cotlet.dev/api/v1/copper-crm/peoples
read
Searches the People section by name or email. Use it before creating a lead or converting one, so you do not make a second person for the same address. Returns person_id, company and Contact Type as Copper shows them. Follow next_cursor for more.
Parameters
| Name | Type | Description |
|---|---|---|
| query string | string | Name or email to search for. |
| limit integer | integer | How many people to return per page. |
| cursor string | string | Next page cursor from the previous call. |
Request
curl https://cotlet.dev/api/v1/copper-crm/peoples \
-H "Authorization: Bearer $COTLET_API_KEY"result = client.call("copper-crm", "list_people")const result = await cotlet.call('copper-crm', 'list_people');cotlet call copper-crm list_peopleExample response
{
"people": [
{
"person_id": "77120458",
"name": "Marta Cole",
"email": "marta@brightside.example",
"company_name": "Brightside Clinic",
"contact_type": "Potential Customer"
}
],
"next_cursor": null
}