Example: Obtaining Apps and Keys for Users and Teams

The examples below use the REST Platform API.

Obtaining a user or team's app IDs

You can use the Get All Apps endpoint to list the app IDs for the team or personal account context selected in the team dropdown. The App ID is known as a projectId in the Platform API.

Here's an example where we list the app IDs of Team A1:

If you have Admin access to the Platform API, you can use the optional on-behalf-of header to obtain the app IDs for any team or user's Personal Account. The value of the on-behalf-of header is the team or user ID.

Here is an example that lists the apps owned by a user with the ID of 7439147:

📘

on-behalf-of header

You can use the on-behalf-of header with Get All Apps. If you don't see that optional header, please contact your Rapid representative.

Obtain an app's details

Once you have obtained an app's ID (see above), you can use the Get App endpoint to obtain it's details.

Here we are obtaining the app details with an app ID of 2688772, which is owned by Team A1. We can obtain details like the app's name and description.

If you have Admin access to the Platform API, you can use the optional on-behalf-of header to obtain the app details for apps owned by any team or user's Personal Account. The value of the on-behalf-of header is the team or user ID.

Here is an example that lists the app details of an app owned by a user with the ID of 7439147:

Obtaining a user or team's app keys

Once you have obtained the app ID (see above), you can call the Get all App Keys endpoint to obtain the app keys (also known as X-RapidAPI-Key) for the app.

📘

X-RapidAPI-Keys only

The Get all App Keys endpoint currently is used only to obtain X-RapidAPI-Key values. If your API uses Authorizations, use the GraphQL Platform API to read and write them. See API Access Provisioning.

Here we are obtaining the app keys for an app with app ID (or project ID) of 2688772. This app is owned by Team A1.

If you have Admin access to the Platform API, you can use the optional on-behalf-of header to obtain the app keys for apps owned by any team or user's Personal Account. The value of the on-behalf-of header is the team or user ID.

Here is an example that lists the app keys an app owned by a user with the ID of 7439147: