💡 Tip: How to View Full Schema Descriptions in Our API Docs

If you’ve ever been unsure about the structure or purpose of a field in our API, be sure to check out the detailed schema descriptions! They can be easy to miss, so here’s how to reveal them:

  1. :mag_right: Locate the Request or Response Section

Head over to the specific endpoint’s documentation. By default, you’ll see an Example view for the request or response.

  1. :bookmark_tabs: Switch to the ‘Schema’ Tab

Next to the Example tab, click on Schema. This shows you all the fields and their data types and descriptions.

  1. :eyes: Expand the Multiline Description

If a field’s description seems cut off, click on the “Multiline description” to see the complete explanation of the object schema, including important notes and usage tips.

Screenshot Walkthrough

1. Schema tab

2. Expand the description

That’s it! Taking a moment to uncover these detailed descriptions can save lots of guesswork when you’re coding or troubleshooting. :rocket: Feel free to drop any questions in the comments below!

3 Likes