Need help with your APIs? I offer API discovery, governance & evangelism services. Explore services →
API Evangelist API Evangelist
Discovery
Learnings
Guidance
Toolbox
Alignment
API Evangelist LLC

xMatters Groups API

The Groups API from xMatters — 3 operation(s) for groups.

xMatters Groups API is one of 11 APIs that xMatters publishes on the APIs.io network, described by a machine-readable OpenAPI specification.

Tagged areas include Groups. The published artifact set on APIs.io includes an OpenAPI specification.

This API exposes 7 operations across 3 paths. It is described by OpenAPI 3.1.0, at version 1.0.

Requests are made against a single base URL, https://{company}.{deployment}.xmatters.com/api/xm/1.

7 operations 3 paths 0 schemas 1 DELETE3 GET2 POST1 PUT

Metadata

The identity and technical contract details declared by the specification.

Specification
OpenAPI 3.1.0
API Version
1.0
Base URL
https://{company}.xmatters.com/api/xm/1
Authentication
HTTP Basic, OAuth 2.0
Resource Areas
1

Authentication & Security 2

xMatters Groups API declares 2 security schemes for authenticating requests. It accepts HTTP basic authentication (BasicAuth). It supports OAuth 2.0 (OAuth2) using the password flow. By default, every request must be authenticated.

  • BasicAuth — HTTP Basic authentication using a username and password or API key.

Paths & Operations 7

Across 3 paths, the API surfaces 7 operations — 1 DELETE, 3 GET, 2 POST, 1 PUT. Each is listed below with its method, path, parameters, and response codes.

Groups 7
GET
/groups
List groups
listGroups → 200
POST
/groups
Create a group
createGroup → 201
GET
/groups/{groupId}
Get a specific group
getGroup 1 param → 200
PUT
/groups/{groupId}
Modify a group
updateGroup 1 param → 200
DELETE
/groups/{groupId}
Delete a group
deleteGroup 1 param → 204
GET
/groups/{groupId}/members
List group members
listGroupMembers 1 param → 200
POST
/groups/{groupId}/members
Add a member to a group
addGroupMember 1 param → 201

Specification

The full machine-readable OpenAPI contract behind this narrative.

Source

xmatters-groups-api-openapi.yml Raw ↑

Other APIs xMatters publishes across the network.

xMatters REST API
xMatters Devices API
xMatters Events API
xMatters Integrations API
xMatters OnCall API
xMatters People API
xMatters Plans API
xMatters Scenarios API
xMatters Services API
xMatters Shifts API