Using the REST Platform API [Basics]

Understanding the Platform API endpoint listing

To get started, navigate to the Platform API in your RapidAPI Enterprise Hub. By default, the Platform Management Organization in your Enterprise Hub will have access to the Platform API. You can add and remove users from this organization if desired.

Endpoints

The Platform API endpoints are organized into groups. You can expand or collapse groups on the left-hand side of the API listing to see the endpoints.

📘

(Environment Admin) Endpoint groups

Certain endpoints groups include "(Environment Admin)" in the name. These endpoints require you to be in a context that has Enterprise Access to the Platform API. Learn how to assign Enterprise Access to the Platform API here.

Context Selection

Context selection allows you to select which team or personal context you are using to make the Platform API calls. You may see a few options or many options, depending on how many entities with access to the Platform API that you are a part of.

On the Platform API listing, the contexts that show up in the context dropdown all have access to the Platform API. However, you will want to take careful note of which context you are in if you plan to use endpoints or features that require Environment Admin access to the Platform API.

To use (Environment Admin) endpoints or other environment admin functionality, you must be in a context that has Enterprise Access to the Platform API.

Parameters

Depending on the endpoint, you may see a variety of optional or required parameters.

For more information on what each parameter requires, see the details in the API listing.

Code Snippets

Like all APIs on the RapidAPI Hub, you can copy and paste a code snippet directly from the API listing. This can be used to integrate the API into your project. You can select from a variety of coding libraries and languages.

📘

The code snippet will update automatically as you fill out parameters and switch contexts on the API listing.