Resource
A file or link resource that can be shared with a group.
Example Request
curl https://api.planningcenteronline.com/groups/v2/group_types/{group_type_id}/resources
Example Object
{
"type": "Resource",
"id": "1",
"attributes": {
"description": "string",
"last_updated": "2000-01-01T12:00:00Z",
"name": "string",
"type": "string",
"visibility": "value"
},
"relationships": {
"created_by": {
"data": {
"type": "Person",
"id": "1"
}
}
}
}
Attributes
| Name | Type | Description |
|---|---|---|
description |
string |
The description of the resource written by the person who created it. |
id |
primary_key |
|
last_updated |
date_time |
The date and time the resource was last updated. |
name |
string |
The name/title of the resource. |
type |
string |
Either |
visibility |
string |
Possible values: |
Relationships
| Name | Type | Association Type | Note |
|---|---|---|---|
| created_by | Person | to_one | The person who created this resource |
Order By
| Parameter | Value | Type | Description |
|---|---|---|---|
| order | last_updated | string | prefix with a hyphen (-last_updated) to reverse the order |
| order | name | string | prefix with a hyphen (-name) to reverse the order |
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/group_types/{group_type_id}/resources |
Reading
| HTTP Method | Endpoint |
|---|---|
| GET | /groups/v2/group_types/{group_type_id}/resources/{id} |
Associations
| HTTP Method | Endpoint | Returns | Details | Filter By |
|---|---|---|---|---|
| GET | https://api.planningcenteronline.com/groups/v2/group_types/{group_type_id}/resources/{resource_id}/download |
Resource | link to download this file resource |
|
| GET | https://api.planningcenteronline.com/groups/v2/group_types/{group_type_id}/resources/{resource_id}/visit |
Resource | link to visit this link resource |
Belongs To
| HTTP Method | Endpoint | Association | Details | Filter By |
|---|---|---|---|---|
| GET | https://api.planningcenteronline.com/groups/v2/groups/{group_id}/resources |
Group | file and link resources shared with this group |
|
| GET | https://api.planningcenteronline.com/groups/v2/group_types/{group_type_id}/resources |
GroupType | file or link resources shared with all groups in this group type |
|
| GET | https://api.planningcenteronline.com/groups/v2/group_types/{group_type_id}/resources/{resource_id}/download |
Resource | link to download this file resource |
|
| GET | https://api.planningcenteronline.com/groups/v2/group_types/{group_type_id}/resources/{resource_id}/visit |
Resource | link to visit this link resource |