Get started

Enable access, create a credential and make your first API request.

1. Turn on API access

   An Organisation Owner enables API and MCP access in Settings. The shared add-on costs US$20 per organisation per calendar month for Cloud and linked Self-Hosted installations. During a trial, Settings shows whether API and MCP access is included. If it shows Included in trial, enable access there; otherwise review the paid activation option. Disabling paid access does not remove the current month's charge.

   For Self-Hosted, enable the add-on in your owning Cloud organisation, let the installation complete its licence check-in, then enable API access in the installation's Settings. Use the installation's own HTTPS address instead of the Cloud API address in these examples.

2. Create a credential

   Create an API credential in Settings. Start with Inventory only for this walkthrough. Choose the whole organisation or one company as its scope. Scope cannot be changed later; create a new credential if you need a different scope.

3. Save the secret

   An API credential has a username and a secret. The secret is shown only when you create or rotate it. Save it in a password manager or secrets store. It is reusable until revoked or expired; it is not a one-time verification code or your login password.

4. Make your first request

   Run the example locally. It prompts for your credential, obtains an access token and lists the first page of devices. Keep the token private. These documentation pages never ask for or store credentials.

   Choose a language and install the dependencies listed below. The examples use the Cloud API address. Never paste real secrets into documentation, support tickets or shared logs.

   cURL: Bash + jq · Python: requests · C#: .NET 8+ (HttpClient)

   C#: dotnet new console → Program.cs → dotnet run

   $credential = Get-Credential
   $body = @{
       username = $credential.UserName
       password = $credential.GetNetworkCredential().Password
       audience = "api"
   } | ConvertTo-Json
   $token = Invoke-RestMethod -Method Post -Uri "https://api.remotegymp.com/v1/auth/token" -ContentType "application/json" -Body $body
   $env:RG_API_TOKEN = $token.accessToken
   Invoke-RestMethod -Uri "https://api.remotegymp.com/v1/devices?pageSize=25" -Headers @{ Authorization = "Bearer $env:RG_API_TOKEN" }

Authentication →

Permissions and scope

A preset selects capabilities, not an access level. Settings creates new credentials with FullAccess; the selected capabilities still restrict access. Review custom permissions before saving. ReadOnly and ReadWrite describe older or separately created credentials, not preset names.

Organisation, company and site

An organisation is your account's top-level boundary. Companies separate customers or business units within it. Sites group devices within a company. A company-scoped credential cannot access another company's data.