Overview
AlertEvents
AlertGroups
AlertRoutingRules
AlertUrgencies
AlertSources
Alerts
Audits
Authorizations
CatalogEntities
CatalogEntityProperties
CatalogFields
Catalogs
[DEPRECATED] CustomFieldOptions
[DEPRECATED] CustomFields
CustomForms
DashboardPanels
Dashboards
Environments
EscalationPolicies
EscalationLevelsPolicies
EscalationLevelsPath
EscalationLevels
EscalationPaths
FormFieldOptions
FormFieldPlacementConditions
FormFieldPlacements
FormFieldPositions
FormFields
FormSetConditions
FormSets
Functionalities
WorkflowTasks
[DEPRECATED] WorkflowCustomFieldSelections
WorkflowFormFieldConditions
WorkflowGroups
WorkflowRuns
Workflows
Heartbeats
IncidentActionItems
[DEPRECATED] IncidentCustomFieldSelections
IncidentEventFunctionalities
IncidentEventServices
IncidentEvents
IncidentFeedbacks
IncidentFormFieldSelections
IncidentPermissionSetBooleans
IncidentPermissionSetResources
IncidentPermissionSets
IncidentRetrospectives
IncidentRetrospectiveSteps
IncidentRoleTasks
IncidentRoles
IncidentStatusPageEvents
IncidentSubStatuses
IncidentTypes
Incidents
- GETList incidents
- POSTCreates an incident
- GETRetrieves an incident
- PUTUpdate an incident
- DELDelete an incident
- PUTMitigate an incident
- PUTResolve an incident
- PUTCancel an incident
- PUTTriage an incident
- PUTRestart an incident
- PUTMark an incident as a duplicate
- POSTAdd subscribers to incident
- DELRemove subscribers from incident
- POSTAssign user to incident
- DELRemove assigned user from incident
IpRanges
LiveCallRouters
OnCallRoles
OnCallShadows
OverrideShifts
PlaybookTasks
Playbooks
RetrospectiveTemplates
RetrospectiveConfigurations
RetrospectiveProcessGroupSteps
RetrospectiveProcessGroups
RetrospectiveProcesses
RetrospectiveSteps
ScheduleRotationActiveDays
ScheduleRotationUsers
ScheduleRotations
Schedules
Services
Severities
StatusPageTemplates
StatusPages
SubStatuses
Teams
UserNotificationRules
WebhooksDeliveries
[DEPRECATED] Retrieves a Custom Field
[DEPRECATED] Retrieves a Custom Field
Retrieves a specific custom_field by id
GET
/
v1
/
custom_fields
/
{id}
curl --request GET \
--url https://api.rootly.com/v1/custom_fields/{id} \
--header 'Authorization: Bearer <token>'
{
"data": {
"id": "2",
"type": "custom_fields",
"attributes": {
"slug": "perspiciatis-ut-consequatur-suscipit",
"description": "Aut magni fugit quia.",
"enabled": true,
"position": 1,
"updated_at": "2025-03-31T06:00:22.509-07:00",
"created_at": "2025-03-31T06:00:22.509-07:00",
"kind": "text",
"label": "Perspiciatis ut consequatur suscipit.",
"shown": [
"incident_form",
"incident_slack_form"
],
"required": []
},
"relationships": {
"options": {
"data": [
{
"id": "4",
"type": "custom_field_options"
},
{
"id": "5",
"type": "custom_field_options"
}
]
}
}
}
}
Authorizations
Bearer authentication header of the form Bearer <token>
, where <token>
is your auth token.
Path Parameters
Query Parameters
comma separated if needed. eg: options
Available options:
options
Response
200
application/vnd.api+json
custom_field found
Unique ID of the custom_field
Available options:
custom_fields
The name of the custom_field
The slug of the custom_field
Where the custom_field is shown
Available options:
incident_form
, incident_mitigation_form
, incident_resolution_form
, incident_post_mortem_form
, incident_slack_form
, incident_mitigation_slack_form
, incident_resolution_slack_form
, incident_post_mortem
Where the custom_field is required
Available options:
incident_form
, incident_mitigation_form
, incident_resolution_form
, incident_post_mortem_form
, incident_slack_form
, incident_mitigation_slack_form
, incident_resolution_slack_form
The position of the custom_field
Date of creation
Date of last update
The kind of the custom_field
Whether the custom_field is enabled
The description of the custom_field
The default value for text field kinds
Was this page helpful?
curl --request GET \
--url https://api.rootly.com/v1/custom_fields/{id} \
--header 'Authorization: Bearer <token>'
{
"data": {
"id": "2",
"type": "custom_fields",
"attributes": {
"slug": "perspiciatis-ut-consequatur-suscipit",
"description": "Aut magni fugit quia.",
"enabled": true,
"position": 1,
"updated_at": "2025-03-31T06:00:22.509-07:00",
"created_at": "2025-03-31T06:00:22.509-07:00",
"kind": "text",
"label": "Perspiciatis ut consequatur suscipit.",
"shown": [
"incident_form",
"incident_slack_form"
],
"required": []
},
"relationships": {
"options": {
"data": [
{
"id": "4",
"type": "custom_field_options"
},
{
"id": "5",
"type": "custom_field_options"
}
]
}
}
}
}