PeopleImportHistory - People API

Example Request

curl https://api.planningcenteronline.com/people/v2/people_imports/{people_import_id}/histories

View in API Explorer →

Example Object

{
  "type": "PeopleImportHistory",
  "id": "1",
  "attributes": {
    "conflicting_changes": {},
    "created_at": "2000-01-01T12:00:00Z",
    "kind": "string",
    "name": "string",
    "updated_at": "2000-01-01T12:00:00Z"
  },
  "relationships": {}
}

Attributes

Name	Type	Description
`conflicting_changes`	`hash`
`created_at`	`date_time`
`id`	`primary_key`
`kind`	`string`
`name`	`string`
`updated_at`	`date_time`

Can Include

Parameter	Value	Description	Assignable
include	household	include associated household
include	person	include associated person

Query By

Name	Parameter	Type	Description	Example
name	`where[name]`	string	Query on a specific name	`?where[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	`/people/v2/people_imports/{people_import_id}/histories`

Reading

HTTP Method	Endpoint
GET	`/people/v2/people_imports/{people_import_id}/histories/{id}`

Associations

HTTP Method	Endpoint	Returns	Details	Filter By
GET	`https://api.planningcenteronline.com/people/v2/people_imports/{people_import_id}/histories/{people_import_history_id}/household`	Household
GET	`https://api.planningcenteronline.com/people/v2/people_imports/{people_import_id}/histories/{people_import_history_id}/person`	Person

Belongs To

HTTP Method	Endpoint	Association	Details	Filter By
GET	`https://api.planningcenteronline.com/people/v2/people_imports/{people_import_id}/histories`	PeopleImport		`creates` `household_creates` `household_updates` `identical` `updates`