PeopleImport - People API - Planning Center

Example Request

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

View in API Explorer →

Example Object

{
  "type": "PeopleImport",
  "id": "1",
  "attributes": {
    "attribs": "string",
    "created_at": "2000-01-01T12:00:00Z",
    "processed_at": "2000-01-01T12:00:00Z",
    "status": "value",
    "undone_at": "2000-01-01T12:00:00Z",
    "updated_at": "2000-01-01T12:00:00Z"
  },
  "relationships": {
    "created_by": {
      "data": {
        "type": "Person",
        "id": "1"
      }
    },
    "undone_by": {
      "data": {
        "type": "Person",
        "id": "1"
      }
    }
  }
}

Attributes

Name	Type	Description
`attribs`	`string`
`created_at`	`date_time`
`id`	`primary_key`
`processed_at`	`date_time`
`status`	`string`	Possible values: `matching`, `processing_preview`, `previewing`, `processing_import`, `complete`, `undone`, or `undoing`
`undone_at`	`date_time`
`updated_at`	`date_time`

Relationships

Name	Type	Association Type	Note
created_by	Person	to_one
undone_by	Person	to_one

Query By

Name	Parameter	Type	Description	Example
status	`where[status]`	string	Query on a specific status Possible values: `matching`, `processing_preview`, `previewing`, `processing_import`, `complete`, `undone`, or `undoing`	`?where[status]=value`

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`

Reading

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

Associations

HTTP Method	Endpoint	Returns	Details	Filter By
GET	`https://api.planningcenteronline.com/people/v2/people_imports/{people_import_id}/conflicts`	PeopleImportConflict		`creates` `creates_and_updates` `errors` `household_creates` `household_updates` `identical` `ignored` `not_ignored` `updates`
GET	`https://api.planningcenteronline.com/people/v2/people_imports/{people_import_id}/histories`	PeopleImportHistory		`creates` `household_creates` `household_updates` `identical` `updates`

Belongs To

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