API
⌘K
My Developer Account

PersonMerger

A Person Merger is the history of profiles that were merged into other profiles.

Example Request

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

View in API Explorer →

Example Object

{
  "type": "PersonMerger",
  "id": "1",
  "attributes": {
    "created_at": "2000-01-01T12:00:00Z",
    "person_to_keep_id": "primary_key",
    "person_to_remove_id": "primary_key"
  },
  "relationships": {
    "person_to_keep": {
      "data": {
        "type": "Person",
        "id": "1"
      }
    },
    "person_to_remove": {
      "data": {
        "type": "Person",
        "id": "1"
      }
    }
  }
}

Attributes

Name Type Description
created_at date_time
id primary_key
person_to_keep_id primary_key
person_to_remove_id primary_key

Relationships

Name Type Association Type Note
person_to_keep Person to_one
person_to_remove Person to_one

Order By

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

Query By

Name Parameter Type Description Example
created_at where[created_at] date_time Query on a specific created_at ?where[created_at]=2000-01-01T12:00:00Z
person_to_keep_id where[person_to_keep_id] primary_key Query on a specific person_to_keep_id ?where[person_to_keep_id]=primary_key
person_to_remove_id where[person_to_remove_id] primary_key Query on a specific person_to_remove_id ?where[person_to_remove_id]=primary_key

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/person_mergers

Reading

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

Belongs To

HTTP Method Endpoint Association Details Filter By
GET https://api.planningcenteronline.com/people/v2/person_mergers Organization