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 People API

The People API from xMatters — 4 operation(s) for people.

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

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

This API exposes 7 operations across 4 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 4 paths 0 schemas 1 DELETE4 GET1 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 People 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 4 paths, the API surfaces 7 operations — 1 DELETE, 4 GET, 1 POST, 1 PUT. Each is listed below with its method, path, parameters, and response codes.

People 7
GET
/people
List people
listPeople → 200
POST
/people
Create a person
createPerson → 201
GET
/people/{personId}
Get a specific person
getPerson 1 param → 200
PUT
/people/{personId}
Modify a person
updatePerson 1 param → 200
DELETE
/people/{personId}
Delete a person
deletePerson 1 param → 204
GET
/people/{personId}/devices
List a person's devices
listPersonDevices 1 param → 200
GET
/people/{personId}/groups
List a person's group memberships
listPersonGroups 1 param → 200

Specification

The full machine-readable OpenAPI contract behind this narrative.

Source

xmatters-people-api-openapi.yml Raw ↑

Other APIs xMatters publishes across the network.

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