Location
A physical event location
Example Request
curl https://api.planningcenteronline.com/groups/v2/events/{event_id}/location
View in API Explorer →
Example Object
{
"type": "Location",
"id": "1",
"attributes": {
"display_preference": "value",
"full_formatted_address": "string",
"latitude": 1.42,
"longitude": 1.42,
"name": "string",
"radius": "string",
"strategy": "string"
},
"relationships": {}
}
Attributes
| Name |
Type |
Description |
display_preference |
string |
This preference controls how the location is displayed to non-members for public groups and events.
Possible values: `hidden`, `approximate`, or `exact` |
full_formatted_address |
string |
Ex: "1313 Disneyland Dr
Anaheim, CA 92802" (may be approximate or `null`)
Approximate address would be "Anaheim, CA 92802".
We obscure Canadian zip codes.
|
id |
primary_key |
|
latitude |
float |
Ex: `33.815396` (may be approximate or `null`)
|
longitude |
float |
Ex: `-117.926399` (may be approximate or `null`)
|
name |
string |
Ex: "Disneyland"
|
radius |
string |
The number of miles in a location's approximate address.
Will be `0` if the strategy is exact, and will be `null` if the strategy is hidden.
|
strategy |
string |
The display preference strategy used for the current request, based on user permissions.
Either `hidden`, `approximate`, or `exact`.
|
Can Include
| Parameter |
Value |
Description |
Assignable |
| include |
group |
include associated group |
|
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/events/{event_id}/location |
Reading
| HTTP Method |
Endpoint |
| GET |
/groups/v2/events/{event_id}/location/{id} |
Associations
| HTTP Method |
Endpoint |
Returns |
Details |
Filter By |
| GET |
https://api.planningcenteronline.com/groups/v2/events/{event_id}/location/{location_id}/group |
Group
|
group that manages this location
|
|
Belongs To
| HTTP Method |
Endpoint |
Association |
Details |
Filter By |
| GET |
https://api.planningcenteronline.com/groups/v2/events/{event_id}/location |
Event
|
physical location of the event
|
|
| GET |
https://api.planningcenteronline.com/groups/v2/groups/{group_id}/location |
Group
|
default physical location for this group's events
|
|