---
updatedAt: 2025-02-14T21:23:03.000Z
agentTools:
  projectIndex: https://partner-docs.gupshup.io/llms.txt
---

# Filter and get list of app for the partner

Use this API to fetch all the list of apps for the account based on the query parameters.

## Parameters

| Key            | Description                                                   | Constraints                                               | Required/Optional |
| :------------- | :------------------------------------------------------------ | :-------------------------------------------------------- | :---------------- |
| PARTNER\_TOKEN | JWT Token issues post Partner login                           | Should be a valid Partner JWT Token.                      |                   |
| name           | App name to be searched (`Contains Search` will be executed)  | If passed with phone & operation will be executed         | Optional          |
| phone          | Phone to be searched (`Contains Search` will be executed)     | Phone to be searched (`Contains Search` will be executed) |                   |
| pageNo         | Page Number. Default is 1 if not passed                       | greater than zero                                         |                   |
| pageSize       | Number of records in a response. Default is 10 if not passed. | greater than zero                                         |                   |

## Sample Request

```curl
curl --location --request GET '{{partner_portal_base_url}}/partner/app/list?name=<name_like>&phone=<phone_like>&pageNo=<page_Number>&pageSize=<elements_per_page>' \ 
--header 'token: {{PARTNER_TOKEN}}'
```

## Sample Response

```json
{
    [
        {
            "id": "<app_id>",
            "name": "<app_name>",
            "type": "<app_type>",
            "live": <true/false>,
            "phone": <phone_number_with_country_code>,
            "stopped": <true/false>,
            "storageRegion": "<BR, DE, CH, GB, BH, ZA, AE, US, CA, AU, ID, IN, JP, SG, KR>",
            "uiFormStage": <>,
            "pipelineStage": <>,
            "creationStage": <>,
            "whatsappVerificationStatus": <>,
            "version": <0,1,2>,
            "products": ["ANALYTICS", "CUSTOMER_SUPPORT"],
            "createdOn": <epoch_timestamp>,
            "modifiedOn": <epoch_timestamp>
        }
    ],
    "status": "success"
}
```

## Status Codes

| Status Code | Response                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                           | Comment                                                             |
| :---------- | :------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | :------------------------------------------------------------------ |
| **Success** |                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    |                                                                     |
| 200         | `{       [{           "id": "\<app_id>",           "name" : "\<app_name>",           "type" : "\<app_type>",           "live": <true/false>,           "phone" : <phone_number_with_country_code>,           "stopped": <true/false>,           "storageRegion" : "\<BR, DE, CH, GB, BH, ZA, AE, US, CA, AU, ID, IN, JP, SG, KR>",           "uiFormStage" : <>,           "pipelineStage" : <>,           "creationStage" : <>,           "whatsappVerificationStatus" : <>,           "version": <0,1,2>,           "products" : ["ANALYTICS", "CUSTOMER_SUPPORT"],           "createdOn": <epoch_timestamp>,           "modifiedOn": <epoch_timestamp>       }],       "status": "success"   }` |                                                                     |
| **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/list": {
      "get": {
        "tags": [
          "App > OnBoarding Api's"
        ],
        "summary": "APP | Filter and get list of app for the partner",
        "parameters": [
          {
            "name": "token",
            "in": "header",
            "schema": {
              "type": "string"
            },
            "example": "{{PARTNER_TOKEN}}"
          },
          {
            "name": "name",
            "in": "query",
            "schema": {
              "type": "string"
            },
            "example": "user name"
          },
          {
            "name": "phone",
            "in": "query",
            "schema": {
              "type": "integer"
            },
            "example": "1234567890"
          },
          {
            "name": "pageNo",
            "in": "query",
            "schema": {
              "type": "integer"
            },
            "example": "1"
          },
          {
            "name": "pageSize",
            "in": "query",
            "schema": {
              "type": "integer"
            },
            "example": "1"
          }
        ],
        "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": {}
            }
          }
        }
      }
    }
  },
  "x-readme": {
    "explorer-enabled": true,
    "proxy-enabled": true
  }
}
```