PlanewardPlaneward Docs
PlanewardPlaneward Docs
Welcome

Developers

REST APIAuthenticationWebhooksMCPEmbedded projectsTask description contentDeveloper hub

API

List events GETCreate an event POSTGet an event GETUpdate an event PATCHDelete an event DELETEList registrations GETRegister a member or contact POSTCancel a member's or contact's registration DELETEGet a contact's registration GETUpdate a registration PATCHUnregister a contact DELETEImport attendance POSTSet one registrant's attendance PUT
Events

List registrations

GET
/events/{eventId}/registrations

Authorization

x-api-key<token>

In: header

Path Parameters

eventId*string

Query Parameters

limit?integer
Rangevalue <= 100
Default50
offset?integer
Range0 <= value
Default0
search?string
attendance?string

Value in

  • "PENDING"
  • "ATTENDED"
  • "LEFT_EARLY"
  • "NO_SHOW"
  • "UNCLASSIFIED"

Response Body

application/json

curl -X GET "https://example.com/events/string/registrations"
{  "data": [    {      "id": "string",      "eventId": "string",      "contactId": "string",      "opportunityId": "string",      "paymentId": "string",      "registeredAt": "2019-08-24T14:15:22Z",      "confirmationSentAt": "2019-08-24T14:15:22Z",      "attendance": "PENDING",      "joinedAt": "2019-08-24T14:15:22Z",      "leftAt": "2019-08-24T14:15:22Z",      "classifiedAt": "2019-08-24T14:15:22Z",      "contact": {        "id": "string",        "name": "string",        "email": "string"      }    }  ],  "meta": {    "total": 0,    "limit": 0,    "offset": 0  }}

Delete an event DELETE

Deletes its registrations. Contacts and deals stay.

Register a member or contact POST

Requires `EVENT_REGISTRATIONS_WRITE` (`CONTACTS_WRITE` also works). Send `memberId` (required for app callers) or `contactId`. Safe to repeat. Returns 201 with `created: true` for a new registration, 200 with `created: false` when already registered. When the event has a pipeline, a new registration opens a deal in its first open stage. App callers can only register for events with `showInCommunity` on, and their response leaves out `contact` and `opportunityId`. A member without a primary contact gets one: their customer's contact with the customer's own email if there is one, else a new contact from the customer record. Another contact of the customer is never made primary, and the customer record is not changed.