API Reference Overview

Use this page to understand how the Switch API Reference is organized and where to find endpoint-level details.

What the API Reference includes

The Switch API Reference contains endpoint documentation for building and validating Switch API integrations. Use it when you need exact details for a request or response.

Each API reference page can include:

• Resource overview: A summary of the resource type and related endpoints.
• Data definitions: Field-level details for request and response objects, including data types and example JSON where available.
• Operations: Supported endpoints, paths, parameters, and example requests and responses.
• Interactive tools: A request builder for constructing API calls directly from the documentation.

Where to find endpoint details

Use the API Reference section in the documentation navigation to find endpoint pages. Endpoint pages typically include:

• HTTP method and path
• Path, query, and body parameters
• Authentication requirements
• Request examples
• Response examples
• Response schemas

If you are new to Switch, start with the Quick Start Guide before using the API Reference for endpoint-level implementation details.

Reference pages to start with

These reference pages are useful when you are getting oriented:

• Authentication: Learn how to authenticate API requests.
• API Basics: Review common API behavior and conventions.
• Requests: Understand request parameters, filtering, fields, sorting, and pagination.
• Responses: Understand standard response envelopes and response fields.
• Echo API: Test credentials, request formatting, and error handling.

How to use the API Reference with guides

Use guides for workflow-level instructions and use the API Reference for exact endpoint details.

For example:

1. Read a guide to understand the workflow and the sequence of API calls.
2. Open the relevant API Reference page for each endpoint.
3. Confirm required parameters, optional parameters, request body shape, and response fields.
4. Use the example requests and responses to validate your implementation.
5. Test credentials and error handling with the Echo API before running larger workflows.

This approach helps you move from workflow context to exact implementation details without guessing how an endpoint behaves.