API
⌘K
My Developer Account

Person

A person is a user of Planning Center. They can be a member of a group, a leader of a group, or an administrator.

Example Request

curl https://api.planningcenteronline.com/groups/v2/people

View in API Explorer →

Example Object

{
  "type": "Person",
  "id": "1",
  "attributes": {
    "addresses": [],
    "avatar_url": "string",
    "child": true,
    "created_at": "2000-01-01T12:00:00Z",
    "email_addresses": [],
    "first_name": "string",
    "last_name": "string",
    "permissions": "string",
    "phone_numbers": []
  },
  "relationships": {}
}

Attributes

Name Type Description
addresses array Returns all the addresses associated with this person.
avatar_url string The URL of the person's avatar.
child boolean Whether or not the person is under 13 years old. This is false if a birthdate is not set. Only available when requested with the `?fields` param
created_at date_time Date and time this person was first created in Planning Center
email_addresses array Returns all the email addresses associated with this person. ```json [{ "address": "sam@example.com", "location": "Home", "primary": true }] ```
first_name string The person's first name.
id primary_key
last_name string The person's last name.
permissions string Can be `administrator`, `group_type_manager`, `leader`, `member`, or `no access`.
phone_numbers array Returns all the phone numbers associated with this person. ```json [{ "number": "(800) 123-4567", "carrier": null, "location": "Mobile", "primary": true }] ```

Order By

Parameter Value Type Description
order first_name string prefix with a hyphen (-first_name) to reverse the order
order last_name string prefix with a hyphen (-last_name) to reverse the order

Query By

Name Parameter Type Description Example
first_name where[first_name] string Query on a specific first_name ?where[first_name]=string
last_name where[last_name] string Query on a specific last_name ?where[last_name]=string

Pagination

Name Parameter Type Description
per_page per_page integer how many records to return per page (min=1, max=100, default=25)
offset offset integer get results from given offset

Endpoints

Listing

HTTP Method Endpoint
GET /groups/v2/people

Reading

HTTP Method Endpoint
GET /groups/v2/people/{id}

Associations

HTTP Method Endpoint Returns Details Filter By
GET https://api.planningcenteronline.com/groups/v2/people/{person_id}/events Event events of groups which this person is a member
  • canceled
  • not_canceled
GET https://api.planningcenteronline.com/groups/v2/people/{person_id}/groups Group groups of which this person is a member
GET https://api.planningcenteronline.com/groups/v2/people/{person_id}/memberships Membership memberships for this person

Belongs To

HTTP Method Endpoint Association Details Filter By
GET https://api.planningcenteronline.com/groups/v2/events/{event_id}/attendances/{attendance_id}/person Attendance person belonging to this attendance
GET https://api.planningcenteronline.com/groups/v2/group_applications/{group_application_id}/person GroupApplication person who applied
GET https://api.planningcenteronline.com/groups/v2/groups/{group_id}/people Group people who have memberships for this group
GET https://api.planningcenteronline.com/groups/v2/groups/{group_id}/memberships/{membership_id}/person Membership
GET https://api.planningcenteronline.com/groups/v2/people Organization people for this organization