PlanewardPlaneward Docs
PlanewardPlaneward Docs
Welcome

Developers

REST APIAuthenticationWebhooksMCPEmbedded projectsTask description contentDeveloper hub

API

Get a bulk job GET
Jobs

Get a bulk job

Poll until status is SUCCEEDED, FAILED, or CANCELLED. Jobs are workspace-scoped.

GET
/jobs/{jobId}

Poll until status is SUCCEEDED, FAILED, or CANCELLED. Jobs are workspace-scoped.

Authorization

x-api-key<token>

In: header

Path Parameters

jobId*string

Response Body

application/json

curl -X GET "https://example.com/jobs/string"
{  "data": {    "id": "string",    "workspaceId": "string",    "kind": "string",    "status": "QUEUED",    "total": 0,    "processed": 0,    "failed": 0,    "input": null,    "result": null,    "error": "string",    "createdByMembershipId": "string",    "createdAt": "2019-08-24T14:15:22Z",    "startedAt": "2019-08-24T14:15:22Z",    "finishedAt": "2019-08-24T14:15:22Z"  }}

Bulk-pause enrollments POST

Body is enrollmentIds or a filter. More than 200 matching active rows returns `{ jobId }` instead of `{ paused }`.

List events GET

Requires `EVENTS_READ` (`CONTACTS_READ` or `CONTACTS_WRITE` also work). Newest first, with a registration count per event. App callers only see events with `showInCommunity` on, without the CRM pipeline, and with `formId` / `form` only for a published form shown in community (see `Event`).