Describe field options
civicrm_describe_field_optionsRetrieve the valid option values for a specific field in a CiviCRM entity, such as activity types or contribution statuses, without loading the entire entity.
Instructions
Return the option list (pseudoconstant values) for a single field on an entity. Far cheaper than civicrm_describe_entity when you only need to know the valid values for one enum-like field — e.g. 'what are the legal activity_type values'.
Input Schema
| Name | Required | Description | Default |
|---|---|---|---|
| field | Yes | Field name whose option list you want, e.g. 'activity_type_id', 'financial_type_id', 'contribution_status_id', 'contact_type'. | |
| entity | Yes | APIv4 entity name, e.g. Activity, Contribution, Contact, Membership. |