0

I might be blind and just not seeing it in the documentation, but is there a parameter that I can pass in that will return all the fields available in an endpoint instead of having to list out all of the fields?

Robert Stovall
  • 3
  • 2

2 Answers2

0

I looked for the same thing when I started working with the API and I don't believe it exists (if it does it's not documented). Whatever fields you explicitly call for are the ones that you get back (if you call for none you get ID and ETAG only).

Whatever solution you come up with for your application, one thing to keep in mind is that if you include a field in the call which doesn't exist on the model, e.g. ask for a field called document on a matter, the entire call will return nothing. So, you can't, for instance, just request all the fields from the entire API, which would be convenient, but you could build up a list of all the fields which occur on a particular subsection. I ended up doing something like that for subfields (which are also not returned unless specifically asked for, which is annoying).

oneWorkingHeadphone
  • 820
  • 9
  • 29
  • Thanks. I'm guessing the answer is no, but do you know if there's a way to get a list of fields for the Custom Fields? My company is currently trying to build out an integration with Clio, and we're hoping to build it so it can be done as dynamically as possible to streamline the process for different clients with the different fields that they may have. – Robert Stovall Mar 06 '19 at 16:04
  • Sorry, your guess is correct :( Custom fields will always come as an array of objects though so if you remap to k/v pairs you should be able to generalize it to whatever is consuming the response. I just finished a project where the client had over 200 custom fields, it was an adventure. My Twitter link is in my profile. Feel free to get in touch if you have other questions. – oneWorkingHeadphone Mar 06 '19 at 17:00
  • @RobertStovall I was wrong about custom fields, you can get all of them here: `api/v4/custom_fields?fields=name,id,parent_type,field_type,deleted` this will give you all the fields in the DB as well as their ID #s so you can target them – oneWorkingHeadphone Mar 08 '19 at 08:55
  • Thanks. Saw that in my third go around with the documentation. Was too focused on the main objects. – Robert Stovall Mar 11 '19 at 22:00
0

All you need to do is ?fields= at the end for return all fields

?fields= returns all with no value needed for a wild card

?fields= returns all with no value needed for a wild card

Craig T Brown
  • 1
  • 1