Campus
A campus as defined in Planning Center Accounts
Example Request
curl https://api.planningcenteronline.com/groups/v2/campuses
Example Object
{
"type": "Campus",
"id": "1",
"attributes": {
"name": "string"
},
"relationships": {}
}
Attributes
| Name | Type | Description |
|---|---|---|
id |
primary_key |
|
name |
string |
The name of the campus |
Order By
| Parameter | Value | Type | Description |
|---|---|---|---|
| order | name | string | prefix with a hyphen (-name) to reverse the order |
Query By
| Name | Parameter | Type | Description | Example |
|---|---|---|---|---|
| id | where[id] |
primary_key | Query on a specific id |
?where[id]=primary_key |
| name | where[name] |
string | Query on a specific name |
?where[name]=string |
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/campuses |
Reading
| HTTP Method | Endpoint |
|---|---|
| GET | /groups/v2/campuses/{id} |
Associations
| HTTP Method | Endpoint | Returns | Details | Filter By |
|---|---|---|---|---|
| GET | https://api.planningcenteronline.com/groups/v2/campuses/{campus_id}/groups |
Group | groups which have applied this campus |
Belongs To
| HTTP Method | Endpoint | Association | Details | Filter By |
|---|---|---|---|---|
| GET | https://api.planningcenteronline.com/groups/v2/groups/{group_id}/campuses |
Group | campuses assigned this group |
|
| GET | https://api.planningcenteronline.com/groups/v2/campuses |
Organization | campuses for this organization |