自定义字段筛选及DocuSign平台自定义字段筛选方法咨询

Hey there! I’ve messed around with DocuSign’s platform and APIs quite a bit, so let me break down how to filter using custom fields—both through the web console and via API.

Using the DocuSign Web Console #

If you’re working directly in the DocuSign dashboard, here’s what to do:

• Head over to the Manage tab where your envelopes are listed
• Look for the Filter button near the top (usually next to the search bar) and click it
• In the filter panel, scroll down or expand the More Filters section to find Custom Fields
• Select the type of custom field you want to filter (text, number, date, etc.), enter the value you’re targeting, and hit Apply to see the filtered results

Using the DocuSign REST API #

If you’re building an integration, you’ll use the listStatusChanges endpoint to filter envelopes by custom fields. Here’s how it works:

• Use a GET request to https://demo.docusign.net/restapi/v2.1/accounts/{your_account_id}/envelopes (swap demo for production if needed)
• Add the custom_field query parameter with an OData-style filter expression. Examples:
  • For a text field named ProjectID with value PROJ-789:
    custom_field=ProjectID eq 'PROJ-789'
  • For a numeric field named ClientNumber with value 456:
    custom_field=ClientNumber eq 456
  • For a date field named SignByDate set to January 1, 2024:
    custom_field=SignByDate eq 2024-01-01T00:00:00Z
• Note: If your custom field is attached to a document (not the envelope itself), use the document_custom_field parameter instead.

Quick Tips to Avoid Headaches #

• Make sure your custom fields are properly assigned to envelopes/documents—if they weren’t added during envelope creation, they won’t show up in filters
• If you’re using templates, define the custom fields in the template first so they’re included when envelopes are created from it
• Double-check the field name spelling—DocuSign’s filter is case-sensitive for custom field names

Let me know if you hit any snags with your specific setup—I’m happy to help troubleshoot further!

备注：内容来源于stack exchange，提问作者Rukzana K A