Skip to content

Get Institution

GET/web/v1/workspaces/{workspaceId}/institutions/{institutionBizId} WEB

Retrieves the details of a specific institution by its business ID.

Required Headers

HeaderExample ValueDescription
Content-Typeapplication/jsonRequest content type
Acceptapplication/jsonExpected response type
X-Client-HashClient device fingerprint
Accept-Languageen, zh, zh-Hant, ja, viResponse language (default: en)
AuthorizationBearerJWT access token

Request Parameters

Path Parameters

NameTypeRequiredInDescription
workspaceIdstringRequiredpathWorkspace business ID
institutionBizIdstringRequiredpathInstitution business ID

Success Response

Success 200
{
  "code": "2000",
  "message": "SUCCESS",
  "data": {
    "bizId": "inst_abc123",
    "institutionName": "Acme Corp",
    "institutionDescription": "Main institution",
    "institutionRemark": null,
    "institutionType": "TENANT",
    "institutionStatus": "ACTIVE",
    "extraConfig": null,
    "createdAt": "2026-03-21T00:00:00Z",
    "updatedAt": "2026-03-21T00:00:00Z"
  }
}

Error Responses

CodeDescription
4010Unauthorized (invalid or missing JWT token)
4040Institution not found

Notes

  • Returns the full institution detail including extra configuration if present.

SlaunchX Internal Documentation