API
⌘K
My Developer Account

Email

An email represents an email address and location.

Example Request 

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

View in API Explorer →

Example Object 

{
  "type": "Email",
  "id": "1",
  "attributes": {
    "address": "string",
    "blocked": true,
    "created_at": "2000-01-01T12:00:00Z",
    "location": "string",
    "primary": true,
    "updated_at": "2000-01-01T12:00:00Z"
  },
  "relationships": {
    "person": {
      "data": {
        "type": "Person",
        "id": "1"
      }
    }
  }
}

Attributes

Name Type Description
address string
blocked boolean
created_at date_time
id primary_key
location string
primary boolean
updated_at date_time

Relationships

Name Type Association Type Note
person Person to_one

Order By

Parameter Value Type Description
order address string

prefix with a hyphen (-address) 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 updated_at string

prefix with a hyphen (-updated_at) to reverse the order

Query By

Name Parameter Type Description Example
address where[address] string

Query on a specific address

 ?where[address]=string
blocked where[blocked] boolean

Query on a specific blocked

 ?where[blocked]=true
created_at where[created_at] date_time

Query on a specific created_at

 ?where[created_at]=2000-01-01T12:00:00Z
location where[location] string

Query on a specific location

 ?where[location]=string
primary where[primary] boolean

Query on a specific primary

 ?where[primary]=true
updated_at where[updated_at] date_time

Query on a specific updated_at

 ?where[updated_at]=2000-01-01T12:00:00Z

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

Reading

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

Creating

HTTP Method Endpoint Assignable Attributes
POST /people/v2/people/{person_id}/emails
  • address
  • location
  • primary

Updating

HTTP Method Endpoint Assignable Attributes
PATCH /people/v2/emails/{id}
  • address
  • location
  • primary

Deleting

HTTP Method Endpoint
DELETE /people/v2/emails/{id}

Associations

HTTP Method Endpoint Returns Details Filter By
GET https://api.planningcenteronline.com/people/v2/emails/{email_id}/person Person

Belongs To

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