Skip to content
Metronome Docs
  • Auto
  • Light
  • Dark
Talk to an expert

List Keys

API Reference
V1
Custom Fields
List custom field keys
post/v1/customFields/listKeys

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

Query Parameters
next_pagestring
optional

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

Body Parameters
entitiesarray of enum
optional

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
dataarray of object
Hide ParametersShow Parameters
enforce_uniquenessboolean
entityenum
"alert" OR "billable_metric" OR "charge" OR 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
curl https://api.metronome.com/v1/customFields/listKeys \
    -H 'Content-Type: application/json' \
    -H "Authorization: Bearer $METRONOME_BEARER_TOKEN"
200 Example
{
  "data": [
    {
      "enforce_uniqueness": true,
      "entity": "alert",
      "key": "key"
    }
  ],
  "next_page": "next_page"
}