ConnectedPerson

A Connected Person is an account from a different organization linked to an account in this organization.

Example Request

curl https://api.planningcenteronline.com/people/v2/people/{person_id}/connected_people

View in API Explorer →

Example Object

{
  "type": "ConnectedPerson",
  "id": "1",
  "attributes": {
    "first_name": "string",
    "gender": "string",
    "given_name": "string",
    "last_name": "string",
    "middle_name": "string",
    "nickname": "string",
    "organization_id": "primary_key",
    "organization_name": "string"
  },
  "relationships": {
    "organization": {
      "data": {
        "type": "Organization",
        "id": "1"
      }
    }
  }
}

Attributes

Name	Type	Description
`first_name`	`string`
`gender`	`string`
`given_name`	`string`
`id`	`primary_key`
`last_name`	`string`
`middle_name`	`string`
`nickname`	`string`
`organization_id`	`primary_key`
`organization_name`	`string`

Relationships

Name	Type	Association Type	Note
organization	Organization	to_one

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	`/people/v2/people/{person_id}/connected_people`

Reading

HTTP Method	Endpoint
GET	`/people/v2/people/{person_id}/connected_people/{id}`

Belongs To

HTTP Method	Endpoint	Association	Details	Filter By
GET	`https://api.planningcenteronline.com/people/v2/people/{person_id}/connected_people`	Person