Return custom fields at the "Get all offers" endpoint

[Wenison_Bandeira]

As described in the link https://pipedrive.readme.io/docs/core-api-concepts-requests, you can specify the fields in the URL. When I type the key for a particular custom field, the values ​​are not returned. How do I solve this problem?

Example: https://api.pipedrive.com/v1/deals:(custon_fields)?filter_id=58&status=all_not_deleted&start=0&api_token=my_token

[mykhailo]

Hi @Wenison_Bandeira

Each custom field has a key, something like this

*you can get deal fields via GET /dealFields request, more here.

And you can use a custom field key in GET /deals like this

https://api.pipedrive.com/v1/deals:(ec5809dadf499095b2fe0cacfca18434b985d7f1)?api_token=<your token>

*response

In other words, you need to use custom fields “key” instead of “custom fields”

[Wenison_Bandeira]

Hi @mykhailo,
I performed the search for the fields using Get all deal fields, but the field I need does not appear in the list. What should I do to make the field appear?

[mykhailo]

Can you see that field in Pipedrive company settings? Settings -> Company settings -> Data fields?

[Wenison_Bandeira]

Yes, the field appears in the company’s settings.!
Image

[mykhailo]

When you hover over a field, do you see an additional menu? If yes, can you copy an API key from there?

If yes, could you double-check if you can find this key in GET /dealFields response? If not, could you share how do you make an HTTP request, something like this https://api.pipedrive.com/v1/dealFields?api_token=<do not show it>&some params

[Wenison_Bandeira]

Yes, I already located the field key on the Pipedrive platform, but when I run https://vaibem.pipedrive.com/api/v1/dealFields?api_token= several fields are returned, except what I need.

[Wenison_Bandeira]

As you can see, when passing the field key in the url empty arrays are returned

[mykhailo]

Hello @Wenison_Bandeira

This field, CPF2 belongs to Persons not Deals. You should be able to get it via GET /personFields.
In GET /deals you can use custom fields created for Deal (not Person).