v1

latestOpenAPI 3.0.22026-07-144652931.4 MB
Enrichment Schemas

Query enrichment data

Query an enrichment schema for records matching a set of field values. Supply up to 3 query fields; all must match. Returns at most one record for standard schemas, or multiple records for schemas that use a discriminator field.

<!-- theme: warning -->

Early Access

This API is in Early Access and may change at any time. Contact your PagerDuty account team to request access.

Scoped OAuth requires: contextual_data.read

post/enrichment/query

Headers

Acceptstring required

The Accept header is used as a versioning header.

Content-Type'application/json' required

Request body

schema_idstring uuid required

The ID of the enrichment schema to query.

Response

The enrichment records matching the query. Returns 0-1 records for standard schemas, or 0-N records for schemas that use a discriminator field.

Example response

{
  "records": [
    {
      "type": "enrichment_record"
    }
  ]
}