---
updatedAt: 2026-08-04T08:50:24.000Z
agentTools:
  projectIndex: https://partner-docs.gupshup.io/llms.txt
---

# Get app details based on appId

Use this API to fetch the app details based on appId.

<Callout icon="🚧" theme="warn">
  ### callbackURL and billingType in response<br />will be deprecated from 19th Feb 2025
</Callout>

### Parameters

<Table align={["left","left","left","left","left","left"]}>
  <thead>
    <tr>
      <th>
        Key
      </th>

      <th>
        Description
      </th>

      <th>
        Constraints
      </th>

      <th>
        Required/Optional
      </th>

      <th>
        Type
      </th>

      <th>
        Value
      </th>
    </tr>
  </thead>

  <tbody>
    <tr>
      <td>
        PARTNER_TOKEN
      </td>

      <td>
        JWT Token issues post Partner login
      </td>

      <td>
        Should be a valid Partner JWT Token.
      </td>

      <td>

      </td>

      <td>
        String
      </td>

      <td>

      </td>
    </tr>

    <tr>
      <td>
        appId
      </td>

      <td>
        id of the app for which data is to be fetched
      </td>

      <td>
        - The id should be a valid app Id of gupshup  - App should be in the account whose PARTNER_TOKEN is being used
      </td>

      <td>

      </td>

      <td>
        String
      </td>

      <td>

      </td>
    </tr>
  </tbody>
</Table>

### Sample Request

```curl
curl --location --request GET '{{partner_portal_base_url}}/partner/app/:appId/details' \
--header 'token: {{PARTNER_TOKEN}}'
```

### Sample Response

```json
{
  "app": {
    "allowNonPersistentTokens": false,
    "businessId": "7821169513xxxx4",
    "createdOn": 1775582754334,
    "disableAppApikey": false,
    "disableGlobalApikey": false,
    "disableOptinPrefUrl": true,
    "embedAllowed": true,
    "federated": false,
    "id": "04505006-xxxx-4d88-xxxx-025205c59245",
    "languageCode": "en_US",
    "live": true,
    "liveTs": 1775766789087,
    "localStorageRegion": "DEFAULT",
    "modifiedOn": 1775766789102,
    "name": "testapp",
    "namespace": "5434b916_c3e4_xxxx_xxxx_6f866abc11a3",
    "newBillingEnabled": true,
    "phone": "5465767886455",
    "phoneId": "1434588789796",
    "provider": "OD",
    "stopped": false,
    "storageRegion": "FBC",
    "templateMessaging": true,
    "type": "apicallbackpost",
    "version": 2
  },
  "status": "success"
}
```

### Status Codes

| Status Code | Response                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                           | Comment                                                             |
| :---------- | :----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | :------------------------------------------------------------------ |
| **Success** |                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    |                                                                     |
| 200         | `{   	"status": "success",    	"appDetails": {    		"billingType": "\<POSTPAID,PREPAID>",    		"createdOn": <timestamp>,           "callbackUrl": "\<callback_url>", //if set    		"disableOptinPrefUrl": \<true/false>,    		"embedAllowed": \<true/false>,    		"federated": \<true/false>,    		"id": "\<app_id>",    		"languageCode": "\<language_code>",   		"live": \<true/false>,    		"liveTs": <timestamp>,    		"modifiedOn": <timestamp>,    		"name": "\<app_name>",           "phone": "phone",    		"stopped": \<true/false>,    		"storageRegion": "\<BR, DE, CH, GB, BH, ZA, AE, US, CA, AU, ID, IN, JP, SG, KR>",    		"templateMessaging": \<true/false>,    		"type": "apicallbackpost",    		"version": \<0,1,2>   	},    	"app": "true"   }` |                                                                     |
| **Error**   |                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    |                                                                     |
| 400         | `{     "status":"error",     "message/data":"<Specific to API>"   }`                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                               | Either the request parameter type or HTTP request type is incorrect |
| 401         | `{     "status":"error",     "message":"Unauthorized Access"   }`                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                  | If the token is incorrect or forbidden.                             |
| 403         | `{     "status":"error",     "message":"Unauthorized Access"   }`                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                  | When app does not belong to the Partner                             |
| 429         | `{     "status": "error",     "message": "Too Many Requests"   }`                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                  | When the rate limit is exceeded                                     |

# OpenAPI definition

```json
{
  "openapi": "3.0.3",
  "info": {
    "title": "Partner Portal Public APIs",
    "version": "1.0.0"
  },
  "servers": [
    {
      "url": "https://partner.gupshup.io"
    }
  ],
  "tags": [
    {
      "name": "App > OnBoarding Api's"
    }
  ],
  "paths": {
    "/partner/app/{appId}/details": {
      "get": {
        "tags": [
          "App > OnBoarding Api's"
        ],
        "summary": "Get app details based on appId",
        "parameters": [
          {
            "name": "token",
            "in": "header",
            "schema": {
              "type": "string"
            },
            "example": "{{PARTNER_TOKEN}}"
          },
          {
            "name": "appId",
            "in": "path",
            "schema": {
              "type": "string"
            },
            "required": true,
            "example": "0ee06d0b-3816-4a44-9594-2eb970f175db"
          }
        ],
        "responses": {
          "200": {
            "description": "Successful response",
            "content": {
              "application/json": {}
            }
          },
          "400": {
            "description": "Bad request",
            "content": {
              "application/json": {}
            }
          },
          "401": {
            "description": "Unauthorized",
            "content": {
              "application/json": {}
            }
          },
          "500": {
            "description": "Internal server error",
            "content": {
              "application/json": {}
            }
          }
        },
        "description": "Use this API to fetch the app details based on appId."
      }
    }
  },
  "x-readme": {
    "explorer-enabled": true,
    "proxy-enabled": true
  }
}
```