Universal App Token

List Universal App Tokens

Lists all UATs ever minted for the app (active, expired, revoked), newest first.

get/partner/app/{appId}/tokens

Request

  • Base URL
    https://partner.gupshup.io
  • URL
    https://partner.gupshup.io/partner/app/{appId}/tokens
  • Auth
    API key in header Authorization

Path parameters

appIdstring uuid required
Example:6f2c9e1a-1b2c-3d4e-5f60-7a8b9c0d1e2f

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

Query parameters

status'ACTIVE' | 'EXPIRED' | 'REVOKED'

ACTIVE - not revoked and expiredOn is still in the future. EXPIRED - not revoked and expiredOn is less than or equal to now (natural expiry). REVOKED - revokedOn is set. Original expiredOn is preserved.

Example:ACTIVE

Status filter. Exact match.

namestring
Example:webhook

Name filter. Case-insensitive substring match.

Response

Successful response. Tokens are wrapped under the tokens field.

statusstring

Example response

{
  "status": "success",
  "tokens": [
    {
      "id": "6f2c9e1a-...",
      "name": "webhook-service",
      "createdByEmail": "admin@example.com",
      "createdOn": 1783053048000,
      "expiredOn": 1783139448000,
      "status": "ACTIVE"
    }
  ]
}

Changes

No recorded changes to this operation across all 1 revision of this API.