Get a Field

Show detailed information about a Custom Field for Services.

Scoped OAuth requires: custom_fields.read

Authorization

api_key

Authorization<token>

The API Key with format Token token=<API_KEY>

In: header

Path Parameters

field_id*string

The ID of the field.

Query Parameters

include[]?"field_options"

Array of additional details to include.

Value in

"field_options"

Header Parameters

Accept*string

The Accept header is used as a versioning header.

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

Content-Type*"application/json"

Default"application/json"

Value in

"application/json"

Response Body

`application/json`

curl -X GET "https://example.com/services/custom_fields/{field_id}" \  -H "Accept: application/vnd.pagerduty+json;version=2" \  -H "Content-Type: application/json"

{  "field": {    "created_at": "2023-01-01T00:00:00Z",    "data_type": "string",    "description": "The environment that the service operates in",    "display_name": "Environment",    "enabled": true,    "field_type": "single_value_fixed",    "id": "ABCDEF1",    "name": "environment",    "self": "https://api.pagerduty.com/services/custom_fields/ABCDEF1",    "summary": "Environment",    "type": "custom_fields_field",    "updated_at": "2023-01-01T00:00:00Z"  }}

Get a Field

Authorization

Path Parameters

Query Parameters

Header Parameters

Response Body

200application/json

403application/json

404application/json

500application/json

`application/json`

`application/json`

`application/json`

`application/json`