OpenAPI V2 schema definition - /dealFields broken

API
, ,
1

Current OpenAPI bundle has bunch of issues when dealing with dealField objects:

  1. Schema requires a non-null description field for /api/v2/dealFields, but server does not actually return this
  2. .options child objects require the id to be int. This isn’t true for following fields Pipedrive builtin fields:
    1. status → id: “open”, etc..
    2. origin→ id: “ManuallyCreated”, etc…

Also, it would be cool if there was a query argument to fetch only user-defined fields (ie where the field_code is that weird hash.

1 Like
2

Thanks for reporting. Both issues are now fixed:

  • options.id is now typed as oneOf: [integer, string] to cover built-in fields like status and origin that return string IDs — this was applied across all entity field schemas, not just deal fields
  • description has been removed from required in the deal field schema

On filtering for user-defined fields only - we have logged the idea and will consider it. Like before, please let us know if you run into anything else!