Sign in Dashboard Get started
  1. Registry
  2. Packages
  3. Incident Provider
  4. API Docs
  5. getCustomField
Viewing docs for incident 7.0.0
published on Friday, Sep 11, 2026 by incident-io
Schema (JSON)
incident-io/terraform-provider-incident

incident.getCustomField

Viewing docs for incident 7.0.0
published on Friday, Sep 11, 2026 by incident-io
Schema (JSON)
incident-io/terraform-provider-incident

    This data source provides information about a custom field.

    Using getCustomField

    Two invocation forms are available. The direct form accepts plain arguments and either blocks until the result value is available, or returns a Promise-wrapped result. The output form accepts Input-wrapped arguments and returns an Output-wrapped result.

    function getCustomField(args: GetCustomFieldArgs, opts?: InvokeOptions): Promise<GetCustomFieldResult>
function getCustomFieldOutput(args: GetCustomFieldOutputArgs, opts?: InvokeOutputOptions): Output<GetCustomFieldResult>
    def get_custom_field(name: Optional[str] = None,
                     opts: Optional[InvokeOptions] = None) -> GetCustomFieldResult
def get_custom_field_output(name: pulumi.Input[Optional[str]] = None,
                     opts: Optional[InvokeOutputOptions] = None) -> Output[GetCustomFieldResult]
    func LookupCustomField(ctx *Context, args *LookupCustomFieldArgs, opts ...InvokeOption) (*LookupCustomFieldResult, error)
func LookupCustomFieldOutput(ctx *Context, args *LookupCustomFieldOutputArgs, opts ...InvokeOption) LookupCustomFieldResultOutput

    > Note: This function is named LookupCustomField in the Go SDK.

    public static class GetCustomField 
{
    public static Task<GetCustomFieldResult> InvokeAsync(GetCustomFieldArgs args, InvokeOptions? opts = null)
    public static Output<GetCustomFieldResult> Invoke(GetCustomFieldInvokeArgs args, InvokeOptions? opts = null)
    public static Output<GetCustomFieldResult> Invoke(GetCustomFieldInvokeArgs args, InvokeOutputOptions opts)
}
    public static CompletableFuture<GetCustomFieldResult> getCustomField(GetCustomFieldArgs args, InvokeOptions options)
public static Output<GetCustomFieldResult> getCustomField(GetCustomFieldArgs args, InvokeOptions options)
public static Output<GetCustomFieldResult> getCustomField(GetCustomFieldArgs args, InvokeOutputOptions options)

    fn::invoke:
  function: incident:index/getCustomField:getCustomField
  arguments:
    # arguments dictionary
    data "incident_get_custom_field" "name" {
    # arguments
}

    The following arguments are supported:

    Name string
    Human readable name for the custom field
    Name string
    Human readable name for the custom field
    name string
    Human readable name for the custom field
    name String
    Human readable name for the custom field
    name string
    Human readable name for the custom field
    name str
    Human readable name for the custom field
    name String
    Human readable name for the custom field

    getCustomField Result

    The following output properties are available:

    CatalogTypeId string
    For catalog fields, the ID of the associated catalog type
    Description string
    Description of the custom field
    FieldType string
    Type of custom field. Possible values are: single_select, multi_select, text, link, numeric.
    FilterBy GetCustomFieldFilterBy
    FixedFilter GetCustomFieldFixedFilter
    Restrict this catalog-backed field's options to catalog entries whose catalog_attribute_id attribute references one of values. This is the static counterpart to filter_by: rather than following whatever another custom field is set to on the incident, the filter is chosen up front and is the same for every incident. Mutually exclusive with filter_by.
    GroupByCatalogAttributeId string
    For catalog fields, the ID of the attribute used to group catalog entries (if applicable)
    HelptextCatalogAttributeId string
    Which catalog attribute provides helptext for the options
    Id string
    The custom field ID
    Name string
    Human readable name for the custom field
    CatalogTypeId string
    For catalog fields, the ID of the associated catalog type
    Description string
    Description of the custom field
    FieldType string
    Type of custom field. Possible values are: single_select, multi_select, text, link, numeric.
    FilterBy GetCustomFieldFilterBy
    FixedFilter GetCustomFieldFixedFilter
    Restrict this catalog-backed field's options to catalog entries whose catalog_attribute_id attribute references one of values. This is the static counterpart to filter_by: rather than following whatever another custom field is set to on the incident, the filter is chosen up front and is the same for every incident. Mutually exclusive with filter_by.
    GroupByCatalogAttributeId string
    For catalog fields, the ID of the attribute used to group catalog entries (if applicable)
    HelptextCatalogAttributeId string
    Which catalog attribute provides helptext for the options
    Id string
    The custom field ID
    Name string
    Human readable name for the custom field
    catalog_type_id string
    For catalog fields, the ID of the associated catalog type
    description string
    Description of the custom field
    field_type string
    Type of custom field. Possible values are: single_select, multi_select, text, link, numeric.
    filter_by object
    fixed_filter object
    Restrict this catalog-backed field's options to catalog entries whose catalog_attribute_id attribute references one of values. This is the static counterpart to filter_by: rather than following whatever another custom field is set to on the incident, the filter is chosen up front and is the same for every incident. Mutually exclusive with filter_by.
    group_by_catalog_attribute_id string
    For catalog fields, the ID of the attribute used to group catalog entries (if applicable)
    helptext_catalog_attribute_id string
    Which catalog attribute provides helptext for the options
    id string
    The custom field ID
    name string
    Human readable name for the custom field
    catalogTypeId String
    For catalog fields, the ID of the associated catalog type
    description String
    Description of the custom field
    fieldType String
    Type of custom field. Possible values are: single_select, multi_select, text, link, numeric.
    filterBy GetCustomFieldFilterBy
    fixedFilter GetCustomFieldFixedFilter
    Restrict this catalog-backed field's options to catalog entries whose catalog_attribute_id attribute references one of values. This is the static counterpart to filter_by: rather than following whatever another custom field is set to on the incident, the filter is chosen up front and is the same for every incident. Mutually exclusive with filter_by.
    groupByCatalogAttributeId String
    For catalog fields, the ID of the attribute used to group catalog entries (if applicable)
    helptextCatalogAttributeId String
    Which catalog attribute provides helptext for the options
    id String
    The custom field ID
    name String
    Human readable name for the custom field
    catalogTypeId string
    For catalog fields, the ID of the associated catalog type
    description string
    Description of the custom field
    fieldType string
    Type of custom field. Possible values are: single_select, multi_select, text, link, numeric.
    filterBy GetCustomFieldFilterBy
    fixedFilter GetCustomFieldFixedFilter
    Restrict this catalog-backed field's options to catalog entries whose catalog_attribute_id attribute references one of values. This is the static counterpart to filter_by: rather than following whatever another custom field is set to on the incident, the filter is chosen up front and is the same for every incident. Mutually exclusive with filter_by.
    groupByCatalogAttributeId string
    For catalog fields, the ID of the attribute used to group catalog entries (if applicable)
    helptextCatalogAttributeId string
    Which catalog attribute provides helptext for the options
    id string
    The custom field ID
    name string
    Human readable name for the custom field
    catalog_type_id str
    For catalog fields, the ID of the associated catalog type
    description str
    Description of the custom field
    field_type str
    Type of custom field. Possible values are: single_select, multi_select, text, link, numeric.
    filter_by GetCustomFieldFilterBy
    fixed_filter GetCustomFieldFixedFilter
    Restrict this catalog-backed field's options to catalog entries whose catalog_attribute_id attribute references one of values. This is the static counterpart to filter_by: rather than following whatever another custom field is set to on the incident, the filter is chosen up front and is the same for every incident. Mutually exclusive with filter_by.
    group_by_catalog_attribute_id str
    For catalog fields, the ID of the attribute used to group catalog entries (if applicable)
    helptext_catalog_attribute_id str
    Which catalog attribute provides helptext for the options
    id str
    The custom field ID
    name str
    Human readable name for the custom field
    catalogTypeId String
    For catalog fields, the ID of the associated catalog type
    description String
    Description of the custom field
    fieldType String
    Type of custom field. Possible values are: single_select, multi_select, text, link, numeric.
    filterBy Property Map
    fixedFilter Property Map
    Restrict this catalog-backed field's options to catalog entries whose catalog_attribute_id attribute references one of values. This is the static counterpart to filter_by: rather than following whatever another custom field is set to on the incident, the filter is chosen up front and is the same for every incident. Mutually exclusive with filter_by.
    groupByCatalogAttributeId String
    For catalog fields, the ID of the attribute used to group catalog entries (if applicable)
    helptextCatalogAttributeId String
    Which catalog attribute provides helptext for the options
    id String
    The custom field ID
    name String
    Human readable name for the custom field

    Supporting Types

    GetCustomFieldFilterBy

    CatalogAttributeId string
    This must be an attribute of the catalog type of this custom field. It must be an attribute that points to another catalog type (so not a plain string, number, or boolean attribute).
    CustomFieldId string
    This must be the ID of a custom field, which must have values of the same type as the attribute you are filtering by.
    CatalogAttributeId string
    This must be an attribute of the catalog type of this custom field. It must be an attribute that points to another catalog type (so not a plain string, number, or boolean attribute).
    CustomFieldId string
    This must be the ID of a custom field, which must have values of the same type as the attribute you are filtering by.
    catalog_attribute_id string
    This must be an attribute of the catalog type of this custom field. It must be an attribute that points to another catalog type (so not a plain string, number, or boolean attribute).
    custom_field_id string
    This must be the ID of a custom field, which must have values of the same type as the attribute you are filtering by.
    catalogAttributeId String
    This must be an attribute of the catalog type of this custom field. It must be an attribute that points to another catalog type (so not a plain string, number, or boolean attribute).
    customFieldId String
    This must be the ID of a custom field, which must have values of the same type as the attribute you are filtering by.
    catalogAttributeId string
    This must be an attribute of the catalog type of this custom field. It must be an attribute that points to another catalog type (so not a plain string, number, or boolean attribute).
    customFieldId string
    This must be the ID of a custom field, which must have values of the same type as the attribute you are filtering by.
    catalog_attribute_id str
    This must be an attribute of the catalog type of this custom field. It must be an attribute that points to another catalog type (so not a plain string, number, or boolean attribute).
    custom_field_id str
    This must be the ID of a custom field, which must have values of the same type as the attribute you are filtering by.
    catalogAttributeId String
    This must be an attribute of the catalog type of this custom field. It must be an attribute that points to another catalog type (so not a plain string, number, or boolean attribute).
    customFieldId String
    This must be the ID of a custom field, which must have values of the same type as the attribute you are filtering by.

    GetCustomFieldFixedFilter

    CatalogAttributeId string
    This must be an attribute of the catalog type of this custom field. It must be an attribute that points to another catalog type (so not a plain string, number, or boolean attribute).
    Values List<string>
    The catalog entry IDs (of the type the attribute points at) that the attribute must reference. The options for this custom field are restricted to entries matching one of these values.
    CatalogAttributeId string
    This must be an attribute of the catalog type of this custom field. It must be an attribute that points to another catalog type (so not a plain string, number, or boolean attribute).
    Values []string
    The catalog entry IDs (of the type the attribute points at) that the attribute must reference. The options for this custom field are restricted to entries matching one of these values.
    catalog_attribute_id string
    This must be an attribute of the catalog type of this custom field. It must be an attribute that points to another catalog type (so not a plain string, number, or boolean attribute).
    values list(string)
    The catalog entry IDs (of the type the attribute points at) that the attribute must reference. The options for this custom field are restricted to entries matching one of these values.
    catalogAttributeId String
    This must be an attribute of the catalog type of this custom field. It must be an attribute that points to another catalog type (so not a plain string, number, or boolean attribute).
    values List<String>
    The catalog entry IDs (of the type the attribute points at) that the attribute must reference. The options for this custom field are restricted to entries matching one of these values.
    catalogAttributeId string
    This must be an attribute of the catalog type of this custom field. It must be an attribute that points to another catalog type (so not a plain string, number, or boolean attribute).
    values string[]
    The catalog entry IDs (of the type the attribute points at) that the attribute must reference. The options for this custom field are restricted to entries matching one of these values.
    catalog_attribute_id str
    This must be an attribute of the catalog type of this custom field. It must be an attribute that points to another catalog type (so not a plain string, number, or boolean attribute).
    values Sequence[str]
    The catalog entry IDs (of the type the attribute points at) that the attribute must reference. The options for this custom field are restricted to entries matching one of these values.
    catalogAttributeId String
    This must be an attribute of the catalog type of this custom field. It must be an attribute that points to another catalog type (so not a plain string, number, or boolean attribute).
    values List<String>
    The catalog entry IDs (of the type the attribute points at) that the attribute must reference. The options for this custom field are restricted to entries matching one of these values.

    Package Details

    Repository
    incident incident-io/terraform-provider-incident
    License
    Notes
    This Pulumi package is based on the incident Terraform Provider.
    Viewing docs for incident 7.0.0
    published on Friday, Sep 11, 2026 by incident-io
    Schema (JSON)
    incident-io/terraform-provider-incident

      Try Pulumi Cloud free.
      Your team will thank you.

      Start free trial