SignupLocation
Signup_location is the location of a signup.
Example Request
curl https://api.planningcenteronline.com/registrations/v2/signups/{signup_id}/signup_location
View in API Explorer →
Example Object
{
"type": "SignupLocation",
"id": "1",
"attributes": {
"address_data": "json",
"created_at": "2000-01-01T12:00:00Z",
"formatted_address": "string",
"full_formatted_address": "string",
"latitude": "string",
"location_type": "string",
"longitude": "string",
"name": "string",
"subpremise": "string",
"updated_at": "2000-01-01T12:00:00Z",
"url": "string"
},
"relationships": {}
}
Attributes
| Name |
Type |
Description |
address_data |
json |
The address data of the signup location, which includes details like street, city, state, and postal code.
Only available when requested with the `?fields` param |
created_at |
date_time |
|
formatted_address |
string |
The formatted address of the signup location, which may not include subpremise details.
|
full_formatted_address |
string |
The fully formatted address of the signup location, including subpremise details.
|
id |
primary_key |
|
latitude |
string |
The latitude of the signup location.
|
location_type |
string |
The type of location, such as `address`, `coords`, or `online`.
|
longitude |
string |
The longitude of the signup location.
|
name |
string |
The name of the signup location.
|
subpremise |
string |
The subpremise of the signup location, such as an building or room number.
|
updated_at |
date_time |
|
url |
string |
The URL for the signup location, if applicable (e.g., for online events).
|
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 |
/registrations/v2/signups/{signup_id}/signup_location |
Reading
| HTTP Method |
Endpoint |
| GET |
/registrations/v2/signups/{signup_id}/signup_location/{id} |
Belongs To
| HTTP Method |
Endpoint |
Association |
Details |
Filter By |
| GET |
https://api.planningcenteronline.com/registrations/v2/signups/{signup_id}/signup_location |
Signup
|
|
|