Clio API v4选择列表类型自定义字段值获取方法咨询

Hey there, let's sort out this picklist custom field issue you're facing with Clio API v4! I know it's frustrating when the v2 approach doesn't translate directly, so here's the breakdown of how to get the data you need:

The Key Difference from v2 #

In Clio API v2, you could directly pull the picklist option name from custom_field_picklist_option, but v4 restructured how custom field data is returned. That's why adding custom_field_picklist_option to your fields parameter throws an invalid field error—it no longer exists in that context.

The Correct Approach for v4 #

To get the picklist option name, you need to expand the custom_field associated with each custom_field_value, then match the value (which is the option ID) to the corresponding option in the picklist options array.

Step 1: Update Your API Request URL

Modify your fields parameter to include the custom_field object and its picklist_options (with id and name):

url = "https://app.clio.com/api/v4/matters/" + str(matterid) + "/?fields=display_number, description, client{id, name}, custom_field_values{field_name, field_type, value, custom_field{picklist_options{id, name}}}"

Step 2: Extract the Picklist Name from the Response

Once you get the API response, loop through the custom_field_values and match the picklist ID (stored in value) to the corresponding name in custom_field.picklist_options:

# Example Python code to process the response
import requests

# Assume you have your auth headers set up
headers = {"Authorization": "Bearer YOUR_ACCESS_TOKEN"}
response = requests.get(url, headers=headers)
matter_data = response.json()

for custom_field in matter_data["custom_field_values"]:
    if custom_field["field_type"] == "picklist":
        # Get the picklist option ID from the value field
        option_id = custom_field["value"]
        # Find the matching option name in the picklist options
        picklist_name = next(
            opt["name"] for opt in custom_field["custom_field"]["picklist_options"] 
            if opt["id"] == option_id
        )
        print(f"{custom_field['field_name']}: {picklist_name}")

Why This Works #

In v4, picklist custom field values store the ID of the selected option in the value field, not the name. By expanding the custom_field and its picklist_options, you get the full list of available options for that field, letting you map the ID back to the human-readable name.

内容的提问来源于stack exchange，提问作者DrGorilla