List Universal Tokens

Lists Universal Tokens for the partner (active, expired, and revoked), newest first.

Recent Requests
Log in to see full request history
TimeStatusUser Agent
Retrieving recent requests…
LoadingLoading…

Description

  1. Optionally filter by status and/or name.
  2. Filters are optional and combinable (status AND name).
  3. Raw JWTs are never returned.

Rate limit

30 requests / 60 seconds.

API Request

with filters

curl --location --request GET 'https://partner.gupshup.io/partner/{{PARTNER_ID}}/auth/tokens?status=ACTIVE&name=prod' \
--header 'Authorization: Bearer {{UNIVERSAL_TOKEN}}'

without filters

curl --location --request GET 'https://partner.gupshup.io/partner/{{PARTNER_ID}}/auth/tokens' \
--header 'Authorization: Bearer {{UNIVERSAL_TOKEN}}'

Response

Status CodeResponseComments
200[ { "id": "row-id-789", "name": "prod-automation", "createdByEmail": "[email protected]", "createdOn": 1783053048000, "expiredOn": 1783939200000, "revokedOn": null, "status": "ACTIVE" } ]Success. Body is a JSON array (not wrapped). status is ACTIVE, EXPIRED, or REVOKED.
401{ "status": "error", "message": "Unauthorised access to the resource. Please review request parameters and headers and retry" }Missing/invalid authentication (JwtAuthenticationEntryPoint).
403{ "status": "error", "message": "Forbidden Access" }Path partnerId does not match authenticated partner context (AuthPathValidator), or caller lacks PARTNER_ADMIN.
429{ "status": "error", "message": "Too Many Requests" }More than 30 requests / 60 seconds.
500{ "status": "error", "message": "Internal server error. Please try again later and If Issue still persist then contact Gupshup Dev Support" }Unexpected server failure.

Request Parameters

KeyDescriptionValuesData TypeRequired / OptionalConstraints
Headers
AuthorizationCaller credentialBearer {{UNIVERSAL_TOKEN}}StringRequiredUT Bearer, Partner UI session, or Partner token with PARTNER_ADMIN.
Path
partnerIdPartner IDe.g. 8814IntegerRequiredMust match authenticated partner context.
Query
statusStatus filterACTIVE, EXPIRED, REVOKEDStringOptionalExact match (case-insensitive compare in filter).
nameName filterprodStringOptionalCase-insensitive substring match on token name.

Token Status

StatusMeaning
ACTIVENot revoked and expiredOn is still in the future.
EXPIREDNot revoked and expiredOn ≤ now (natural expiry).
REVOKEDrevokedOn is set. Original expiredOn is preserved for inspection.

Path Params
int64
required

Partner ID. Must match the partner resolved from email (mint),
or the authenticated partner context (list and revoke).

Query Params
string
enum

Status filter. Exact match (case-insensitive compare in filter).

Allowed:
string

Name filter. Case-insensitive substring match on token name.

Responses

Language
Credentials
Header
LoadingLoading…
Response
Click Try It! to start a request and see the response here! Or choose an example:
application/json