Skip to content

List Portals

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

Returns all portal entries for a given institution.

Authentication

Requires a valid JWT token. Gateway validation: enableJwtToken=true, enableTurnstile=false.

Request Parameters

Path Parameters

NameTypeRequiredInDescription
workspaceIdstringYespathWorkspace business ID
institutionBizIdstringYespathInstitution business ID

Success Response

Success200
{
  "code": "2000",
  "message": "SUCCESS",
  "data": [
    {
      "id": 1,
      "institutionBizId": "inst_abc123",
      "portalType": 10010102,
      "domain": "https://tenant.example.com",
      "portalStatus": 10080101,
      "remark": 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 an array of all portals associated with the institution.

Internal Documentation