API
⌘K
My Developer Account

Rule

A rule belongs to a List and groups conditions together.

Example Request 

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

View in API Explorer →

Example Object 

{
  "type": "Rule",
  "id": "1",
  "attributes": {
    "created_at": "2000-01-01T12:00:00Z",
    "subset": "string",
    "updated_at": "2000-01-01T12:00:00Z"
  },
  "relationships": {}
}

Attributes

Name Type Description
created_at date_time
id primary_key
subset string
updated_at date_time

Can Include

Parameter Value Description Assignable
include conditions

include associated conditions

Order By

Parameter Value Type Description
order created_at string

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

prefix with a hyphen (-subset) 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
created_at where[created_at] date_time

Query on a specific created_at

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

Query on a specific subset

 ?where[subset]=string
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/lists/{list_id}/rules

Reading

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

Associations

HTTP Method Endpoint Returns Details Filter By
GET https://api.planningcenteronline.com/people/v2/lists/{list_id}/rules/{rule_id}/conditions Condition

Belongs To

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