API
⌘K
My Developer Account

ListShare

A list share indicates who has access to edit a list.

Example Request 

curl https://api.planningcenteronline.com/people/v2/lists/{list_id}/shares

View in API Explorer →

Example Object 

{
  "type": "ListShare",
  "id": "1",
  "attributes": {
    "created_at": "2000-01-01T12:00:00Z",
    "group": "value",
    "name": "string",
    "permission": "value"
  },
  "relationships": {
    "person": {
      "data": {
        "type": "Person",
        "id": "1"
      }
    }
  }
}

Attributes

Name Type Description
created_at date_time
group string

Possible values: No Access, Viewer, Editor, or Manager
id primary_key
name string
permission string

Possible values: view or manage

Relationships

Name Type Association Type Note
person Person to_one

Can Include

Parameter Value Description Assignable
include person

include associated person

 create and update

Order By

Parameter Value Type Description
order created_at string

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

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

Query on a specific group

Possible values: No Access, Viewer, Editor, or Manager

 ?where[group]=value
name where[name] string

Query on a specific name

 ?where[name]=string
permission where[permission] string

Query on a specific permission

Possible values: view or manage

 ?where[permission]=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/lists/{list_id}/shares

Reading

HTTP Method Endpoint
GET /people/v2/lists/{list_id}/shares/{id}

Creating

HTTP Method Endpoint Assignable Attributes
POST /people/v2/lists/{list_id}/shares
  • permission
  • group
  • person_id

Updating

HTTP Method Endpoint Assignable Attributes
PATCH /people/v2/lists/{list_id}/shares/{id}
  • permission
  • group

Deleting

HTTP Method Endpoint
DELETE /people/v2/lists/{list_id}/shares/{id}

Associations

HTTP Method Endpoint Returns Details Filter By
GET https://api.planningcenteronline.com/people/v2/lists/{list_id}/shares/{list_share_id}/person Person

Belongs To

HTTP Method Endpoint Association Details Filter By
GET https://api.planningcenteronline.com/people/v2/lists/{list_id}/shares List