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

Get a contact's registration

404 when the contact is not registered.

GET
/events/{eventId}/registrations/{contactId}

404 when the contact is not registered.

Authorization

x-api-key<token>

In: header

Path Parameters

eventId*string
contactId*string

Response Body

application/json

curl -X GET "https://example.com/events/string/registrations/string"
{  "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"    }  }}

Cancel a member's or contact's registration DELETE

Requires `EVENT_REGISTRATIONS_WRITE` (`CONTACTS_WRITE` also works). Pass exactly one of `memberId` (required for app callers) or `contactId`. Safe to repeat: `cancelled` is false when there was no registration. Emits `event.registration_cancelled`. The contact and any deal stay.

Update a registration PATCH

Patch attendance, join/leave times, or the linked opportunity. Pass null on opportunityId to unlink. Contact and opportunity records stay. Changing attendance emits event.attendance_classified.