| API | Protocol | Base URL | Docs | Reference | OpenAPI | SDKs |
|---|---|---|---|---|---|---|
| Main | rest | https://{company}.xmatters.com/api/xm/1 | link | — | — | — |
Actions (47)
WORKFLOWS AND COMMUNICATION PLANS · 40
- Create communication planPOST /plans
Create a new communication plan.
documented - Create plan constantPOST /plans/{planId}/constants
Create a constant for a plan.
documented - Create plan endpointPOST /plans/{planId}/endpoints
Create an endpoint for a plan.
documented - Create plan endpointPOST /plans/{planId}/endpoints
Create an endpoint for a plan.
documented - Create plan formPOST /plans/{planId}/forms
Create a new form for a plan.
documented - Create plan formPOST /plans/{planId}/forms
Create a new form within a plan.
documented - Create plan integrationPOST /plans/{planId}/integrations
Create or modify an integration for a plan.
documented - Delete communication planDELETE /plans/{planId}
Delete a communication plan.
documented - Delete plan constantDELETE /plans/{planId}/constants/{constantId}
Delete a constant for a plan.
documented - Delete plan endpointDELETE /plans/{planId}/endpoints/{endpointId}
Delete an endpoint from a plan.
documented - Delete plan endpointDELETE /plans/{planId}/endpoints/{endpointId}
Remove an endpoint from a plan.
documented - Delete plan integrationDELETE /plans/{planId}/integrations/{integrationId}
Delete a plan integration.
documented - Get communication planGET /plans/{planId}
Retrieve a specific plan by id or name.
documented - Get formGET /forms/{formId}
Retrieve a specific form.
documented - Get form in planGET /plans/{planId}/forms/{formId}
Retrieve a specific form within a plan.
documented - Get form message templatesGET /forms/{formId}/message-templates
Retrieve message templates associated with a form.
documented - Get form recipients (plan context)GET /plans/{planId}/forms/{formId}/recipients
List default recipients configured for a form within a plan.
documented - Get form response optionsGET /forms/{formId}/response-options
Retrieve the response options for a form.
documented - Get form sectionsGET /forms/{formId}/sections
Retrieve sections of a form.
documented - Get form sender permissions (plan context)GET /plans/{planId}/forms/{formId}/sender-permissions
Retrieve sender permissions for a form within a plan.
documented - Get plan form recipientsGET /plans/{planId}/forms/{formId}/recipients
Retrieve recipients for a specific form in a plan.
documented - Get plan form sender permissionsGET /plans/{planId}/forms/{formId}/sender-permissions
Retrieve sender permissions for a form in a plan.
documented - Get plan integrationGET /plans/{planId}/integrations/{integrationId}
Get a specific plan integration.
documented - Get subscription formGET /subscription-forms/{subscriptionFormId}
Retrieve a subscription form by id.
documented - Get subscription formGET /subscription-forms/{subscriptionFormId}
Retrieve a subscription form by id.
documented - List communication plansGET /plans
Retrieve all communication plans (plans/workflows) in the system.
documented - List formsGET /forms
Get all forms used by plans.
documented - List forms in planGET /plans/{planId}/forms
List all forms defined in a given plan.
documented - List plan constantsGET /plans/{planId}/constants
List constants for a plan.
documented - List plan constantsGET /plans/{planId}/constants
List constants for a plan.
documented - List plan endpointsGET /plans/{planId}/endpoints
List endpoints configured for a plan.
documented - List plan endpointsGET /plans/{planId}/endpoints
List endpoints configured for a plan.
documented - List plan formsGET /plans/{planId}/forms
List all forms for a plan.
documented - List plan formsGET /plans/{planId}/forms
List forms for a plan.
documented - List plan integrationsGET /plans/{planId}/integrations
List integrations for a plan.
documented - List subscription formsGET /subscription-forms
Get all subscription forms.
documented - List subscription formsGET /subscription-forms
Get all subscription forms.
documented - List subscription forms in planGET /plans/{planId}/subscription-forms
List subscription forms for a specific plan.
documented - Modify communication planPOST /plans
Modify an existing communication plan (payload includes id).
documented - Modify plan integrationPOST /plans/{planId}/integrations/{integrationId}
Modify a plan integration.
documented
DEVICES · 5
- Create or update devicePOST /devices
Create or modify a device (POST to /devices).
documented - Delete deviceDELETE /devices/{deviceId}
Delete a device by ID.
documented - Get deviceGET /devices/{deviceId}
Retrieve a single device.
documented - List devicesGET /devices
Get all devices (with optional embedded timeframes).
documented - Update devicePUT /devices
Modify an existing device (payload includes id).
documented