Skip to main content

How to return only the fields you need

Every response of the Sally API can be reduced to the fields you actually need with ?fields=. That keeps answers small and shields your integration from fields that are added later.

GET /v1.0/directories/{directoryId}/recordings?fields=recordingId,name,createdOn

Quick navigation

  1. The rules
  2. Where it pays off

1. The rules​

  • Leave it out and you get every field, including fields added in the future. Naming your fields protects you from that.
  • First-level names only. A nested list such as attendees, tags, segments or sectionItems comes whole or not at all. attendees.name is not supported.
  • On a paged response the selection applies to the entries in items. The envelope from Pagination & search is always returned.
  • An unknown name is rejected with 400 instead of being ignored. A typo therefore fails loudly instead of quietly returning half an answer.

2. Where it pays off​

Result

A transcript consists almost entirely of segments, a summary with details almost entirely of sectionItems. Leave one of them out and the response gets much smaller.

The reference lists the names each endpoint accepts under its fields parameter.