Pular para o conteúdo

List sub-tenants by tenant

Returns every sub-tenant that belongs to the same parent tenant as the subTenantId you provide. Useful when a tenant operates multiple brands or environments and you need to enumerate them.

GET/api/v1/sub-tenants/tenant

List sub-tenants by tenant

Returns the list of sub-tenants sharing the same parent tenant as the provided subTenantId.

Auth: Bearer Token

Parâmetros de query

1 campo
subTenantId●
querystring

Any sub-tenant identifier under the tenant you want to list. The endpoint resolves the parent tenant from this value and returns all of its sub-tenants.

curl --request GET \
  --url 'https://embedded-payment-manager.hml.linaob.com.br/api/v1/sub-tenants/tenant?subTenantId=subTenant123' \
  --header 'Authorization: Bearer <SEU_TOKEN>'

Response

200Sub-tenants retrieved successfully.
Response body
object
  • dataarray of objectsrequired

    Sub-tenants that share the resolved parent tenant.

    • itemobject
  • messagestring

    Response message.

  • typestring

    Response type. One of `error`, `warning`, `info`, `success`.

  • statusCodeinteger· nullable

    HTTP status code carried inside the envelope.

200 · Sub-tenants retrieved successfully.
{
  "data": [
    {
      "id": "subTenant123",
      "name": "SubTenant A",
      "subTenantId": "subTenant123",
      "eppIamClientId": "eppClient123",
      "urlLogo": "http://example.com/logo.png",
      "primaryColor": "#000000",
      "secondaryColor": "#FFFFFF",
      "urlFont": "http://example.com/font.ttf",
      "nameFont": "Arial",
      "tenant": {
        "tenantId": "tenant123",
        "name": "Tenant A",
        "rpIamClientId": "rpClient123"
      },
      "domains": [
        "app.example.com.br"
      ]
    },
    {
      "id": "subTenant456",
      "name": "SubTenant B",
      "subTenantId": "subTenant456",
      "eppIamClientId": "eppClient456",
      "urlLogo": "http://example.com/logo-b.png",
      "primaryColor": "#123456",
      "secondaryColor": "#FEDCBA",
      "urlFont": "http://example.com/font-b.ttf",
      "nameFont": "Roboto",
      "tenant": {
        "tenantId": "tenant123",
        "name": "Tenant A",
        "rpIamClientId": "rpClient123"
      },
      "domains": [
        "checkout.example.com.br"
      ]
    }
  ],
  "message": "OK",
  "type": "success",
  "statusCode": 200
}

Next steps