RIrillet
Metadata

Lists all metadata definitions

Changed on

Returns the organization's metadata definitions: the custom fields that can hold values on accounts, bills, contracts, customers, and invoices. Keys are permanent identifiers derived from the name at creation; API consumers bind to keys, which never change on rename. At most 50 active definitions can be assigned to one entity type. Definitions are managed in Settings, not through this API.

get/metadata-definitions

Request

Query parameters

entity_type'ACCOUNT' | 'BILL' | 'CONTRACT' | 'CUSTOMER' | 'INVOICE'

Only definitions assigned to this entity type.

status'ACTIVE' | 'ARCHIVED'

ARCHIVED definitions stop accepting new values but stay readable wherever a value exists.

Only definitions with this status. Omit to return both.

Response

OK

Example response

{
  "metadata_definitions": [
    {
      "key": "metadata.source_invoice_id",
      "name": "source_invoice_id",
      "max_length": 256
    }
  ]
}

Changes