Get Partner Token

This API endpoint enables partners to authenticate and login to the Partner Portal system. It supports both UI-based login (with secure cookies) and API-based login (with JWT tokens). The endpoint validates credentials, generates authentication tokens, and returns comprehensive partner information including permissions, billing details, and feature flags.

📘

Note:

The partner token will be used as authorization in other Partner APIs. Currently, the expiry for the token is 24 hours.

Rate limit is 10 requests per 60 seconds


Request Parameters

KeyValueDescription
Email{{EMAIL}}Email address through partner has signed up on partner portal
Password{{PASSWORD/CLIENT_SECRET}}Password/Client Secret set by the partner on the partner portal

Sample Request

curl --location --request POST 'https://partner.gupshup.io/partner/account/login' \
--header 'Accept: application/json' \
--header 'Content-Type: application/x-www-form-urlencoded' \
--data-urlencode 'email={{EMAIL}}' \
--data-urlencode 'password={{PASSWORD/CLIENT_SECRET}}'

Sample Response

{
  "token": "{{PARTNER_TOKEN}}",
  "id": 1**3,
  "name": "gupshup",
  "terms_read": true,
  "admin": true,
  "email": "[email protected]",
  "activationRead": false,
  "billingType": "PREPAID",
  "contactName": "peter",
  "phoneNumber": "898",
  "enableCustomer": false,
  "enableWallet": true,
  "enableInrWallet": false,
  "enableLoaderWallet": false,
  "enableAppOnboarding": true,
  "isTpp": false,
  "onboardEnabled": false
}
Language
Click Try It! to start a request and see the response here!