SelectionType - Registrations API

Example Request

curl https://api.planningcenteronline.com/registrations/v2/attendees/{attendee_id}/selection_type

View in API Explorer →

Example Object

{
  "type": "SelectionType",
  "id": "1",
  "attributes": {
    "at_maximum_capacity": true,
    "available_capacity": 1,
    "created_at": "2000-01-01T12:00:00Z",
    "maximum_capacity": 1,
    "name": "string",
    "price_cents": 1,
    "price_currency": "string",
    "price_currency_symbol": "string",
    "price_formatted": "string",
    "publicly_available": true,
    "updated_at": "2000-01-01T12:00:00Z",
    "waitlist": true
  },
  "relationships": {}
}

Attributes

Name	Type	Description
`at_maximum_capacity`	`boolean`	Whether the selection type has reached its maximum capacity. Only available when requested with the `?fields` param
`available_capacity`	`integer`	Remaining spots for this selection type (`maximum_capacity` minus active registrations). `null` when there is no capacity limit. Only available when requested with the `?fields` param
`created_at`	`date_time`
`id`	`primary_key`
`maximum_capacity`	`integer`	Maximum number of attendees this selection type can hold. `null` when there is no capacity limit.
`name`	`string`	Name of the selection type.
`price_cents`	`integer`	Price of selection type in cents.
`price_currency`	`string`	Signup currency code, example `"USD"`. Only available when requested with the `?fields` param
`price_currency_symbol`	`string`	Signup currency symbol, example `"$"`. Only available when requested with the `?fields` param
`price_formatted`	`string`	Price of selection type with currency formatting (symbol not included). Only available when requested with the `?fields` param
`publicly_available`	`boolean`	Whether or not the selection type is available to the public.
`updated_at`	`date_time`
`waitlist`	`boolean`	Whether the selection type offers a waitlist once it is full.

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/attendees/{attendee_id}/selection_type`

Notes:

Organization admins can see all selection types for all signups. Signup managers can only see the selection types for signups they manage.

Reading

HTTP Method	Endpoint
GET	`/registrations/v2/attendees/{attendee_id}/selection_type/{id}`

Notes:

Organization admins can see all selection types for all signups. Signup managers can only see the selection types for signups they manage.

Belongs To

HTTP Method	Endpoint	Association	Details	Filter By
GET	`https://api.planningcenteronline.com/registrations/v2/attendees/{attendee_id}/selection_type`	Attendee
GET	`https://api.planningcenteronline.com/registrations/v2/signups/{signup_id}/selection_types`	Signup		`publicly_available`