What’s in the REST API Reference Section

This section has the main details about each of our Switch API endpoints and the data structures that are passed in and come out of them. We start with some basics, including how to make secure calls and what is common about requests and responses.

The actual functionality of our Switch API endpoints is organized into logical groups that put together common resource types:

How we structure each page in this section

Each page is for one resource type. Is contents start with an overview of that page’s resource type and related endpoints. This lets you know if you are in the right page. Next up is a Data Definition section. This tells you in detail what fields are returned, what their data type is, and what is typically contained in them. There will usually be an example in JSON too. Then the page will have an Operations section that shows the endpoints available and the path and parameters supported for each endpoint. You’ll find a number of examples that show the request and sometimes response for common use-cases.