EventNote
Notes that group leaders can write for an event, generally related to attendance.
Example Request
curl https://api.planningcenteronline.com/groups/v2/event_notes
Example Object
{
"type": "EventNote",
"id": "1",
"attributes": {
"body": "string"
},
"relationships": {
"annotatable": {
"data": {
"type": "Annotatable",
"id": "1"
}
},
"owner": {
"data": {
"type": "Owner",
"id": "1"
}
}
}
}
Attributes
| Name | Type | Description |
|---|---|---|
body |
string |
The body text of the note. |
id |
primary_key |
Relationships
| Name | Type | Association Type | Note |
|---|---|---|---|
| annotatable | Annotatable | to_one | |
| owner | Owner | to_one |
Can Include
| Parameter | Value | Description | Assignable |
|---|---|---|---|
| include | owner | include associated owner |
create and update |
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 | /groups/v2/event_notes |
Reading
| HTTP Method | Endpoint |
|---|---|
| GET | /groups/v2/event_notes/{id} |
Associations
| HTTP Method | Endpoint | Returns | Details | Filter By |
|---|---|---|---|---|
| GET | https://api.planningcenteronline.com/groups/v2/event_notes/{event_note_id}/owner |
Owner | person who created the note |
Belongs To
| HTTP Method | Endpoint | Association | Details | Filter By |
|---|---|---|---|---|
| GET | https://api.planningcenteronline.com/groups/v2/events/{event_id}/notes |
Event | notes added to the event |
|
| GET | https://api.planningcenteronline.com/groups/v2/event_notes |
Organization | event notes for all groups in this organization |