API
⌘K
My Developer Account

ListResult

A list result

Example Request 

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

View in API Explorer →

Example Object 

{
  "type": "ListResult",
  "id": "1",
  "attributes": {
    "created_at": "2000-01-01T12:00:00Z",
    "updated_at": "2000-01-01T12:00:00Z"
  },
  "relationships": {
    "person": {
      "data": {
        "type": "Person",
        "id": "1"
      }
    },
    "list": {
      "data": {
        "type": "List",
        "id": "1"
      }
    }
  }
}

Attributes

Name Type Description
created_at date_time
id primary_key
updated_at date_time

Relationships

Name Type Association Type Note
person Person to_one
list List 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 updated_at string

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

Query By

Name Parameter Type Description Example
person_id where[person_id] integer

Query on a related person

 ?where[person_id]=1

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}/list_results

Reading

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

Associations

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

Belongs To

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