This reference documents Grorapid Platform backend resources together with the integration, external API, and vendor callback routes that support the platform.

Need to run the platform first?

Open the Grorapid Platform getting-started guide for Docker setup, environment configuration, production URLs, and reverse proxy examples.

​
Base URL

Use the backend origin directly for Grorapid Platform API requests:
  • Production backend API URL: https://platform.grorapid.com
  • Local backend API URL: http://localhost:8989
The frontend portal is a separate application surface:
  • Production portal URL: https://portal.grorapid.com
  • Local portal URL: http://localhost:3000
Some routes also target operation-specific hosts such as https://api.grorapid.com, https://platform.binaryprospect.com, https://www.linkedin.com, https://api.stripe.com, and https://webhooks.grorapid.com. Each endpoint page calls that out when it does not use the main backend origin.

​
What this reference covers

The sidebar is organized by product area and includes these major areas:
  • account and registration
  • user, roles, permissions, and subscriptions
  • brands, OEM partners, audiences, contacts, and segments
  • campaigns, emails, forms, webpages, media groups, and sending servers
  • workflows, delays, conditions, recipes, and recipe steps
  • integrations, external endpoints, Stripe requests, and PMTA requests

​
Authentication

Grorapid Platform uses bearer-token authentication by default: 
Authorization: Bearer <token>
Some routes override that default when they target an external service or callback flow:
  • public auth flows such as login, registration, and password recovery are marked without auth
  • the Stripe payment intent request uses Stripe’s auth requirements because it calls Stripe directly

​
Response envelope

Many Grorapid backend responses follow a common envelope like this: 
{
  "version": "v1",
  "status": true,
  "statusCode": 200,
  "details": "OK",
  "statusMessage": "success",
  "response": {}
}
Not every operation uses the same shape. Integration, external, and vendor-specific requests can return different payloads, so treat the saved examples on each endpoint as the most specific source of truth.

​
Usage notes

  • Some endpoints share the same backend path but support multiple product flows. When that happens, the endpoint description lists the supported variants.
  • Saved request bodies and responses were sanitized so examples keep their structure without exposing real secrets or personal data.
  • Integration, external, and vendor-specific endpoints can use their own hosts, auth schemes, or response shapes.

​
Next step

If you still need to stand up the platform locally or on a server, follow the Grorapid Platform getting-started guide.