Search people

People profiles that match a name or email.

GET https://cotlet.dev/api/v1/planning-center/peoples/search

read

Searches People for the text you give and returns the matching profiles, best match first. Use person_id with get_person and add_person_note. You only get profiles your account can see in People.

Parameters

Parameters: search_people
NameTypeDescription
query string required string Name or email address to search for.

Request

cURL
curl "https://cotlet.dev/api/v1/planning-center/peoples/search?query=query" \
  -H "Authorization: Bearer $COTLET_API_KEY"
Python
result = client.call("planning-center", "search_people", {"query":"query"})
Node.js
const result = await cotlet.call('planning-center', 'search_people', {"query":"query"});
CLI
cotlet call planning-center search_people --data '{"query":"query"}'

Example response

JSON

{
  "people": [
    {
      "person_id": "48215",
      "name": "Dana Whitfield",
      "email": "dana@example.org"
    },
    {
      "person_id": "48990",
      "name": "Dana Whitfield-Cole",
      "email": "dana.wc@example.org"
    }
  ]
}

Sign in once. Your agent does the rest.

Sign up and add the apps you need. Free 7-day trial with 2,000 credits, no card needed.