List Universal App Tokens

Lists all UATs ever minted for the app (active, expired, 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. Filters are optional and combinable.
  2. Raw JWTs are never returned, and rti / jti are omitted.
  3. The app must be authorised for the authenticated partner. Unlike mint, a list does not require a UT-only bearer; portal, partner, and app tokens are accepted.

Rate limit

30 requests / 60 seconds.


API Request

with filters

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

without filters

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

Response

Status CodeResponseComments
200{ "status": "success", "tokens": [ { "id": "6f2c9e1a-...", "name": "webhook-service", "createdByEmail": "[email protected]", "createdOn": 1783053048000, "expiredOn": 1783139448000, "revokedOn": null, "status": "ACTIVE" } ] }Success. Tokens wrapped under tokens. Raw JWT / rti / jti omitted.
200{ "status": "success", "tokens": [] }Success with no matching rows.
400{ "status": "error", "message": "Partner is not authorized" }App not linked to the authenticated partner.
401{ "status": "error", "message": "Unauthorised access to the resource. Please review request parameters and headers and retry" }Missing/invalid authentication (JwtAuthenticationEntryPoint).
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}}StringRequired
Path
appIdApp IDUUIDStringRequiredMust be linked to the caller's partner.
Query
statusStatus filterACTIVE, EXPIRED, REVOKEDStringOptionalExact match.
nameName filterwebhookStringOptionalCase-insensitive substring match.

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.

Path Params
uuid
required

App ID. Must be linked to the caller's partner.

Query Params
string
enum

Status filter. Exact match.

Allowed:
string

Name filter. Case-insensitive substring match.

Responses

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