get
https://partner.gupshup.io/partner/account/api/partnerApps
Retrieves the list of partner applications linked to the authenticated partner account, including health status from DockerDetails and capping information from CappingDetails
Recent Requests
Log in to see full request history
| Time | Status | User Agent | |
|---|---|---|---|
Retrieving recent requests… | |||
Loading…
Omit page, size, pageSize, searchTerm, custIdSearchTerm, status, sortBy, and order to get the full list. Send any of those query params to get one page plus paging metadata.
Parameters
| Parameters | Value | Description |
|---|---|---|
| Authorization | {{PARTNER_TOKEN}} | JWT Token issued post Partner login. |
| page | 1 | Optional. Page index. 0-based with size; 1-based with pageSize. |
| size | 20 | Optional. Page size (1-100) with 0-based page. Defaults to 20. |
| pageSize | 5 | Optional. Page size (1-100) with 1-based page. Example: page=1&pageSize=5. |
| searchTerm | test | Optional. Case-insensitive match on app name, phone, or app id. |
| custIdSearchTerm | 123 | Optional. Case-insensitive match on customer id. |
| status | Live | Optional. Live or Not Live. |
| sortBy | name | Optional. name, phone, customerId, createdOn, modifiedOn, live, or id. |
| order | desc | Optional. asc or desc. Defaults to desc. |
Sample Request (without pagination)
Future deprecation: The non-paginated full-list contract will be deprecated in a future release. It still works today. Migrate to the paginated request (
pagewithpageSizeorsize) so the response includespage,size,totalElements, andtotalPages.
curl --location --request GET 'https://partner.gupshup.io/partner/account/api/partnerApps' \
--header 'Authorization: {{PARTNER_TOKEN}}'Sample Response (without pagination)
{
"status": "success",
"partnerAppsList": [
{
"id": "00065097-93ff-4c22-bfa4-845f01b7de3b",
"name": "BotTch20",
"customerId": "4000001311",
"live": false,
"partnerId": 6,
"createdOn": 1624339843605,
"modifiedOn": 1651130376253,
"partnerCreated": false,
"cxpEnabled": false,
"partnerUsage": true,
"stopped": false,
"healthy": true,
"cap": 0.0
},
{
"id": "018358b5-5ac1-44af-bbfe-36ac4e9f01cc",
"name": "automation030542",
"customerId": "NA",
"live": false,
"partnerId": 6,
"createdOn": 1703857396150,
"modifiedOn": 1703857396150,
"partnerCreated": false,
"cxpEnabled": false,
"partnerUsage": true,
"stopped": false,
"healthy": true,
"cap": 0.0
},
{
"id": "02f9e530-f7dd-4a04-ad33-4406d29c9e56",
"name": "TestAPI70",
"customerId": "4000001585",
"live": false,
"partnerId": 6,
"createdOn": 1651738868991,
"modifiedOn": 1651738868991,
"partnerCreated": false,
"cxpEnabled": false,
"partnerUsage": true,
"stopped": false,
"healthy": true,
"cap": 0.0
},
{
"id": "04e6c66b-bb95-4bfc-b75e-4e7391ddc680",
"name": "GupShupQAHSM",
"phone": "919324927406",
"customerId": "4000001343",
"live": false,
"partnerId": 6,
"createdOn": 1690874640468,
"modifiedOn": 1698409662019,
"partnerCreated": false,
"cxpEnabled": false,
"partnerUsage": true,
"stopped": false,
"healthy": true,
"cap": 0.0
},
{
"id": "0adef57e-b1fe-41eb-94e7-c47e29fbc50f",
"name": "automation9525531",
"customerId": "NA",
"live": false,
"partnerId": 6,
"createdOn": 1703856050646,
"modifiedOn": 1703856050646,
"partnerCreated": false,
"cxpEnabled": false,
"partnerUsage": true,
"stopped": false,
"healthy": true,
"cap": 0.0
}
]
}Sample Request (with pagination)
curl --location --request GET 'https://partner.gupshup.io/partner/account/api/partnerApps?page=1&pageSize=5&searchTerm=test&status=Live&sortBy=name&order=desc' \
--header 'Authorization: {{PARTNER_TOKEN}}'Sample Response (with pagination)
{
"status": "success",
"partnerAppsList": [
{
"id": "00065097-93ff-4c22-bfa4-845f01b7de3b",
"name": "BotTch20",
"customerId": "4000001311",
"live": false,
"partnerId": 6,
"createdOn": 1624339843605,
"modifiedOn": 1651130376253,
"partnerCreated": false,
"cxpEnabled": false,
"partnerUsage": true,
"stopped": false,
"healthy": true,
"cap": 0.0
}
],
"page": 0,
"size": 5,
"totalElements": 42,
"totalPages": 9
}page in the paginated response is 0-based, even when the request used page=1 with pageSize.