Address - People API - Planning Center

Example Request

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

View in API Explorer →

Example Object

{
  "type": "Address",
  "id": "1",
  "attributes": {
    "city": "string",
    "country_code": "string",
    "country_name": "string",
    "created_at": "2000-01-01T12:00:00Z",
    "location": "string",
    "primary": true,
    "state": "string",
    "street_line_1": "string",
    "street_line_2": "string",
    "updated_at": "2000-01-01T12:00:00Z",
    "zip": "string"
  },
  "relationships": {
    "person": {
      "data": {
        "type": "Person",
        "id": "1"
      }
    }
  }
}

Attributes

Name	Type	Description
`city`	`string`
`country_code`	`string`
`country_name`	`string`
`created_at`	`date_time`
`id`	`primary_key`
`location`	`string`
`primary`	`boolean`
`state`	`string`
`street_line_1`	`string`
`street_line_2`	`string`
`updated_at`	`date_time`
`zip`	`string`

Relationships

Name	Type	Association Type	Note
person	Person	to_one

Order By

Parameter	Value	Type	Description
order	city	string	prefix with a hyphen (-city) to reverse the order
order	country_code	string	prefix with a hyphen (-country_code) to reverse the order
order	created_at	string	prefix with a hyphen (-created_at) to reverse the order
order	location	string	prefix with a hyphen (-location) to reverse the order
order	primary	string	prefix with a hyphen (-primary) to reverse the order
order	state	string	prefix with a hyphen (-state) to reverse the order
order	street_line_1	string	prefix with a hyphen (-streetline1) to reverse the order
order	street_line_2	string	prefix with a hyphen (-streetline2) to reverse the order
order	updated_at	string	prefix with a hyphen (-updated_at) to reverse the order
order	zip	string	prefix with a hyphen (-zip) to reverse the order

Query By

Name	Parameter	Type	Description	Example
city	`where[city]`	string	Query on a specific city	`?where[city]=string`
country_code	`where[country_code]`	string	Query on a specific country_code	`?where[country_code]=string`
location	`where[location]`	string	Query on a specific location	`?where[location]=string`
primary	`where[primary]`	boolean	Query on a specific primary	`?where[primary]=true`
state	`where[state]`	string	Query on a specific state	`?where[state]=string`
street_line_1	`where[street_line_1]`	string	Query on a specific streetline1	`?where[street_line_1]=string`
street_line_2	`where[street_line_2]`	string	Query on a specific streetline2	`?where[street_line_2]=string`
zip	`where[zip]`	string	Query on a specific zip	`?where[zip]=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/addresses`

Reading

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

Creating

HTTP Method	Endpoint	Assignable Attributes
POST	`/people/v2/people/{person_id}/addresses`	city state zip country_code location primary street_line_1 street_line_2

Updating

HTTP Method	Endpoint	Assignable Attributes
PATCH	`/people/v2/addresses/{id}`	city state zip country_code location primary street_line_1 street_line_2

Deleting

HTTP Method	Endpoint
DELETE	`/people/v2/addresses/{id}`

Belongs To

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