I’ve seen this question answered for V1 and in xmlRpc, but I’m needing to figure this out using the new REST V2. I can actually update my custom fields as I know their ids, but I’m not rather new to working with REST and I’m not sure what I should be doing to get a contact by a value in the custom …

Hi @Brian_Quimby , @pagedesigner , @MarcPSummers , @Pav , @Nathan_Donnelly and @geekgoddess . Custom field filtering is now available in REST v2 for the following resources: Contacts Companies Orders Affiliates For these supported resources, custom fields can be filtered just like any oth…

i think you will use two api calls, one to List Contacts and another Retrieve a Contact with contact id and filter the contact with your custom field value

Thanks for the input. I really don’t want to do that as it means moving all the data to a client app to search for the key to the one record I want. That approach would be impossible if there were 10s of thousands of records to look through.

yea i agree that not the best option with REST API V2 but i think its the only option right now, i suggest use REST API V1

[image] pagedesigner: custom_fields Getting the custom_fields can be done using the fields parameter. What I’m trying to do is filter the query based on the value of one of the custom_fields.

We do not currently index custom field values for filtering due to system constraints.

Do you know if this ever got updated? Are custom fields indexed now?

No, Custom Fields are currently not indexed. This is not a defect, but a constraint based on how they are stored, retrieved, and the various types of data contained in them.

So if I wanted to look up a contact based on a custom field value I can’t do that? Find ContactID for CutomFieldID4 when data equals string? Is this not possible?

@TomScott , it is looking like that the REST V2 API is not going to be comparable to the XML-RPC API. If I run a Custom Field search it takes a couple of seconds to return the results back via the XML-RPC. I am wondering why it is an issue to implement that functionality into REST? You can make ch…

Looking up values in custom contact field with REST V2 API

API Q&A

pagedesigner (Page Designer) April 7, 2022, 7:21pm 5

i just test you can use query parameter ‘optional_properties’ => custom_fields in REST API V2 call and it will return the custom fields also

REST v2 - Improvements Request

Topic		Replies	Views
Can I search using the API for contacts based on custom fields API Q&A custom-fields , api	10	2799	July 17, 2026
URGENT: Critical blocker for XML-RPC migration - Missing Custom Field search in REST API API Q&A custom-field-query	4	94	July 16, 2026
Search Company or Contact Custom Fields API Q&A	10	107	July 16, 2026
Looking up people via custom field API Q&A	2	49	July 16, 2026
Get contacts filter by custom field value API Q&A	1	794	January 16, 2019

Looking up values in custom contact field with REST V2 API

Related topics