Update API to include the fieldname and descriptive label

[Pam Minkey]

Can the label on the far right of the UI form be included in the API call.  For example, 'field4405076' has the label of 'Last Name' in the UI (see UI Screenshot) but only the unique field descriptor of 'field4405076'' is sent on the API call. (see json api.json).  Can the descriptive label be included on the api call?

[Christopher Perez]

Hello Pam,

When requesting form data, the label value will be included in the field data of the response. When requesting updates, i.e. PUT or POST requests, the payload of the request is only expecting the field identifiers to be updated/created, which should be in the 'field12345' format.

I hope this helps. Let me know if you have any followup questions.

Thank you,

Chris P

[Pam Minkey]

Hi Chris P.  

The question is regarding the GET.  I am not updating Zengine with PUT or POST.  I would like the descriptive label, in addition to 'field12345' format as part of the response to my GET API call.  Is that possible.  Currently I am not receiving that as part of the data payload.  This is an example of my GET endpoint:  https://api.zenginehq.com/v1/forms/[redacted]/records.json?min-modified=2025-07-27T21:00:00.000-07:00&limit=4580&page=1&access_token=[redacted]

How can I modify the request to get these descriptive labels?  I provided a screen shot of what I am getting back in my original post. 

Thanks

Pam

[Christopher Perez]

Hi Pam,

Unfortunately, you cannot get field data like that from a records request. The descriptive labels for each field aren't returned from the records endpoint. In order to get the descriptive labels of each field, you'll need to first query the form you intend to pull records from. You'll use something like 

https://api.zenginehq.com/v1/forms/[redacted]/fields

Which will then return the data you're looking for. From there, you can combine the data with your records query.

 see the Zengine API docs for full details. 

Thank You,

Chris P.