Property whitelists are used to limit the properties of resources in the server response. This is mainly useful for reducing data overhead.
When using a whitelist, only the properties specified by the whitelist are returned, except for
_embedded which are always returned when applicable.
|properties[ path ]||string||Comma-separated list of property names|
Adding a path to the properties parameter is optional. Without a path, the whitelist applies to the main resource being requested. You can apply the whitelist to an embedded resource by specifying a path that matches the embedded relations as specified using the embed parameter.
GET https://api.speakap.io/networks/0123456789abcdef/messages/0000000000000000/ ?embed=author&properties=body,created&properties[author]=avatarThumbnailUrl,fullName GET https://api.speakap.io/networks/0123456789abcdef/memberships/ ?embed=membership.user&properties[membership]=role,since&properties[membership.user]=fullName