GQL Platform API Overview

📘

Note: The GraphQL Platform API is currently in preview. We welcome your feedback on anything that you encounter. Please send feedback to https://support.rapidapi.com/.

📘

If you are new to GraphQL, graphql.org is a good learning resource.

As described in this blog post, RapidAPI internally uses GraphQL as its primary API type. The GraphQL Platform API exposes this API to your enterprise, allowing you to make the same queries and mutations that RapidAPI uses internally.

The GraphQL Platform API is used by Enterprise Hub administrators and (optionally) API providers to obtain and modify data in the Enterprise Hub. All types of entities in the Enterprise Hub, can be queried and modified using the GraphQL Platform API, including:

• APIs
• Users
• Teams
• Roles
• Permissions
• Categories
• Tags
• Collections
• Audit logs
• (and many more)

The GraphQL Platform API can be used to automate many processes related to the Enterprise Hub. For example, when a change to an API definition file is merged in your code repository, the GraphQL Platform API can be called via your CI/CD pipeline to automatically update the API definition in the Enterprise Hub.

GraphQL Platform API resources

Use the following resources to help you successfully use the GraphQL Platform API in your enterprise.

Getting Started with the GraphQL Platform API

Examples

• Working with APIs
• API Subscriptions
• API Followers
• API Announcements
• API Authentication
• Apps and authorizations
• Users, Teams, and Roles
• Organizations
• Categories, Tags, and Collections
• API Statistics
• Administration

Concepts

• Authorization
• Pagination
• Arguments

Release Notes