API
⌘K
My Developer Account

SocialProfile

A social profile represents a members's Twitter, Facebook, or other social media account.

Example Request 

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

View in API Explorer →

Example Object 

{
  "type": "SocialProfile",
  "id": "1",
  "attributes": {
    "created_at": "2000-01-01T12:00:00Z",
    "site": "string",
    "updated_at": "2000-01-01T12:00:00Z",
    "url": "string",
    "verified": true
  },
  "relationships": {}
}

Attributes

Name Type Description
created_at date_time
id primary_key
site string
updated_at date_time
url string
verified boolean

Can Include

Parameter Value Description Assignable
include person

include associated person

Order By

Parameter Value Type Description
order created_at string

prefix with a hyphen (-created_at) to reverse the order
order site string

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

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

prefix with a hyphen (-url) to reverse the order
order verified string

prefix with a hyphen (-verified) 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
site where[site] string

Query on a specific site

 ?where[site]=string
updated_at where[updated_at] date_time

Query on a specific updated_at

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

Query on a specific url

 ?where[url]=string
verified where[verified] boolean

Query on a specific verified

 ?where[verified]=true

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

Reading

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

Creating

HTTP Method Endpoint Assignable Attributes
POST /people/v2/people/{person_id}/social_profiles
  • site
  • url
  • verified

Updating

HTTP Method Endpoint Assignable Attributes
PATCH /people/v2/social_profiles/{id}
  • site
  • url
  • verified

Deleting

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

Associations

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

Belongs To

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