List Keys

API Reference

V1

Custom Fields

List custom field keys

v1.custom_fields.list_keys(**kwargs) -> dataarraynext_pageStringCustomFieldListKeysResponse

post/v1/customFields/listKeys

List all active custom field keys, optionally filtered by entity type.

Parameters

next_pageString

optional

Cursor that indicates where the next page of results should start.

entitiesarray

optional

Array[:alert | :billable_metric | :charge | 15 more]

Optional list of entity types to return keys for

Hide ParametersShow Parameters

:alert

:billable_metric

:charge

:commit

:contract_credit

:contract_product

:contract

:credit_grant

:customer_plan

:customer

:discount

:invoice

:plan

:professional_service

:product

:rate_card

:scheduled_charge

:subscription

Returns

CustomFieldListKeysResponseclass

Hide ParametersShow Parameters

dataarray

Array[{ enforce_uniqueness, entity, key}]

Hide ParametersShow Parameters

enforce_uniquenessbool

entityunion

:alert | :billable_metric | :charge | 15 more

Hide ParametersShow Parameters

:alert

:billable_metric

:charge

:commit

:contract_credit

:contract_product

:contract

:credit_grant

:customer_plan

:customer

:discount

:invoice

:plan

:professional_service

:product

:rate_card

:scheduled_charge

:subscription

keyString

next_pageString

HTTPTypeScriptPythonGoRubyTerraform

require "metronome_sdk"

metronome = MetronomeSDK::Client.new(bearer_token: "My Bearer Token")

response = metronome.v1.custom_fields.list_keys

puts(response)

200 Example

{
  "data": [
    {
      "enforce_uniqueness": true,
      "entity": "alert",
      "key": "key"
    }
  ],
  "next_page": "next_page"
}