Get all tenants for a given stack

1min

GET
This is an api for retrieving all the tenants onboarded on a given stack with ability to filter by the subscription status and tenant country. Returns empty array if no tenants are found.
Path Parameters
stackId
string
*
Header Parameters
x-developerplatform-access
string
*
Query Parameters
itemId
string
isSubscribed
boolean
Responses
200
TenantPerStackDTO[]
tenantId
string
*
status
string
associatedOrganization
string
isSubscriptionActive
boolean
countryCode
string
organizationShortName
String
400
Given stackId does not exist
BadRequestErrorResponseDTO
error
BadRequestErrorDTO
*
request
StandardRequestDTO
*
Curl
JS
Ruby
Python
curl --location --globoff '/developer/stack/{stackId}/tenants' \
--header 'Accept: application/json' \
--header 'Content-Type: application/json'
curl --location --globoff '/developer/stack/{stackId}/tenants' \
--header 'Accept: application/json' \
--header 'Content-Type: application/json'
Responses
200
400
[
  {
    "tenantId": "",
    "status": "",
    "associatedOrganization": "",
    "isSubscriptionActive": false,
    "countryCode": "IN",
    "organizationShortName": "delhiveryindia"
  }
]
[
  {
    "tenantId": "",
    "status": "",
    "associatedOrganization": "",
    "isSubscriptionActive": false,
    "countryCode": "IN",
    "organizationShortName": "delhiveryindia"
  }
]
﻿
﻿

Updated 10 Oct 2024

Did this page help you?

Get versions diff or permissions diff

Get access token based on username and password