Sign in

v11

latestOpenAPI 3.1.0Apache 2.0raw.githubusercontent.com2026-08-017364211.0 KB
Admin

Retrieve a Tenant

get/tenants/{id}

Path parameters

idstring required

ID or Name of the Tenant.

Response

Tenant details

idstring required
namestring required

The tenant name. It should match the pattern ^[a-z-]+$.

base_urlstring required

The SDP backend server's base URL.

sdp_ui_base_urlstring required

The SDP UI/dashboard Base URL.

status'TENANT_CREATED' | 'TENANT_PROVISIONED' | 'TENANT_ACTIVATED' | 'TENANT_DEACTIVATED' required
distribution_account_addressstring required

The Stellar account address used for distributing funds.

distribution_account_type'DISTRIBUTION_ACCOUNT.STELLAR.ENV' | 'DISTRIBUTION_ACCOUNT.STELLAR.DB_VAULT' | 'DISTRIBUTION_ACCOUNT.CIRCLE.DB_VAULT' required

The Stellar account type used for distributing funds.

distribution_account_status'ACTIVE' | 'PENDING_USER_ACTIVATION' required

The status of the distribution account used for distributing funds.

is_defaultboolean required

Boolean flag that shows whether the tenant is the default or not.

created_atstring date-time required
updated_atstring date-time required
deleted_atstring date-time

The timestamp when the tenant was (soft) deleted.

Example response

{
  "id": "840dca45-d1df-44cd-83c1-65c04235c25f",
  "name": "redcorp",
  "base_url": "https://redcorp-backend.sdp.org",
  "sdp_ui_base_url": "https://redcorp.sdp.org",
  "status": "TENANT_PROVISIONED",
  "distribution_account": "GCQVDMPOEN3HHJJ64V42KUTONOXN7C6V2PSVPALEVJ7PIYOB6M3DJV7N",
  "is_default": true,
  "created_at": "2024-03-27T17:21:51.000Z",
  "updated_at": "2024-03-27T17:21:51.000Z"
}