API
⌘K
My Developer Account

EventConnection

A connection between a Calendar event and a record in another product

Example Request

curl https://api.planningcenteronline.com/calendar/v2/events/{event_id}/event_connections

View in API Explorer →

Example Object

{
  "type": "EventConnection",
  "id": "1",
  "attributes": {
    "connected_to_id": "primary_key",
    "connected_to_name": "string",
    "connected_to_type": "string",
    "connected_to_url": "string",
    "product_name": "string",
    "promoted": true
  },
  "relationships": {
    "event": {
      "data": {
        "type": "Event",
        "id": "1"
      }
    }
  }
}

Attributes

Name Type Description
connected_to_id primary_key Unique identifier for the connected record
connected_to_name string Name of the record that the event is connected to
connected_to_type string Currently we support `signup`, `group`, `event`, and `service_type`
connected_to_url string A link to the connected record
id primary_key
product_name string Currently we support `registrations`, `groups`, `check-ins`, and `services`
promoted boolean Whether this connection is promoted for display (only applies to Groups connections) Only available when requested with the `?fields` param

Relationships

Name Type Association Type Note
event Event to_one

Query By

Name Parameter Type Description Example
connected_to_id where[connected_to_id] primary_key Query on a specific connected_to_id ?where[connected_to_id]=primary_key
product_name where[product_name] string Query on a specific product_name ?where[product_name]=string
promoted where[promoted] boolean Query on a specific promoted ?where[promoted]=true

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 /calendar/v2/events/{event_id}/event_connections

Reading

HTTP Method Endpoint
GET /calendar/v2/events/{event_id}/event_connections/{id}

Creating

HTTP Method Endpoint Assignable Attributes
POST /calendar/v2/events/{event_id}/event_connections
  • connected_to_id
  • connected_to_name
  • connected_to_type
  • product_name
  • promoted

Updating

HTTP Method Endpoint Assignable Attributes
PATCH /calendar/v2/events/{event_id}/event_connections/{id}
  • connected_to_id
  • connected_to_name
  • connected_to_type
  • product_name
  • promoted

Deleting

HTTP Method Endpoint
DELETE /calendar/v2/events/{event_id}/event_connections/{id}

Belongs To

HTTP Method Endpoint Association Details Filter By
GET https://api.planningcenteronline.com/calendar/v2/events/{event_id}/event_connections Event