Formatting Responses

This page includes miscellaneous information on how to engage with Wristband APIs and additional functionality.

Response Pretty Printing

For most Wristband APIs, you can format the response to be "pretty" printed by appending the following query parameter to the request: ?pretty=true.

Warning
Pretty printing should only be used by developers to make it easier to read the response data. Never use pretty printing in production as it adds extra formatting data to the response which is not needed.

For example, calling the Get User API with the following request:

GET https://yourapp-yourcompany.us.wristband.dev/api/v1/users/123?fields=id,givenName,familyName HTTP/2.0
Accept: application/json

The JSON response body typically looks something like the following:

{"id":"123","givenName":"Bob","familyName":"Smith"}

By enabling pretty printing, the response body is formatted with indentations and line breaks, enhancing its readability for human interpretation:

{
  "id": "123",
  "givenName": "Bob",
  "familyName": "Smith"
}