GET /incidents/types/{type_id_or_name}/custom_fields/{field_id}

Get a custom field for an incident type.

Custom Fields (CF) are a feature which will allow customers to extend Incidents with their own custom data, to provide additional context and support features such as customized filtering, search and analytics. Custom Fields can be applied to different incident types.

Scoped OAuth requires: custom_fields.read

Servers

Path parameters

Name Type Required Description
type_id_or_name String Yes

The ID or name of the Incident Type.

field_id String Yes

The ID of the field.

Request headers

Name Type Required Description
Accept String Yes

The Accept header is used as a versioning header.

Default value: "application/vnd.pagerduty+json;version=2"

Content-Type String Yes

Possible values:

  • "application/json"

Default value: "application/json"

Query parameters

Name Type Required Description
include String No

Array of additional details to include.

Possible values:

  • "field_options"

How to start integrating

  1. Add HTTP Task to your workflow definition.
  2. Search for the API you want to integrate with and click on the name.
    • This loads the API reference documentation and prepares the Http request settings.
  3. Click Test request to test run your request to the API and see the API's response.