Jump to

• Request
• Response

List Organization Networks

get

/v1/uwaas/organization-networks

Lists organization network configurations across all organizations. When `orgId` is provided, results are restricted to that organization.

Request

Query Parameters

• instanceId: string
  Optional instance identifier used to filter organization networks.
• nextPageToken: string
  Opaque cursor returned by the previous page.
• orgId: string
  Organization identifier.

  Example:

  default_org

• pageSize: integer
  Minimum Value: 1

  Maximum Value: 200

  Maximum number of organization networks to return.

  Default Value: 5

  Example:

  5

There's no request body for this operation.

Back to Top

Response

Supported Media Types

• application/json

200 Response

Organization networks retrieved successfully.

Body ()

Root Schema : ListOrganizationNetworksResponse

Type: object

Show Source

• items(required): array items
• nextPageToken: string
  Example: MjAyNi0wNy0xM1QxODozODowOXw3

{
    "type":"object",
    "properties":{
        "items":{
            "type":"array",
            "items":{
                "$ref":"#/components/schemas/OrganizationNetworkSummaryResponse"
            }
        },
        "nextPageToken":{
            "type":"string",
            "nullable":true,
            "example":"MjAyNi0wNy0xM1QxODozODowOXw3"
        }
    },
    "required":[
        "items"
    ]
}

Nested Schema : items

Type: array

Show Source

• Array of: OrganizationNetworkSummaryResponse

{
    "type":"array",
    "items":{
        "$ref":"#/components/schemas/OrganizationNetworkSummaryResponse"
    }
}

Nested Schema : OrganizationNetworkSummaryResponse

Match All

Show Source

• object OrganizationNetworkResponse

{
    "allOf":[
        {
            "$ref":"#/components/schemas/OrganizationNetworkResponse"
        }
    ]
}

Nested Schema : OrganizationNetworkResponse

Type: object

Show Source

• accessType(required): string
  Allowed Values: [ "INSTANCE", "GLOBAL" ]

  Example: INSTANCE
• blockchainType(required): string
  Maximum Length: 64

  Example: BESU
• chainId(required): string
  Maximum Length: 128

  Example: 1337
• createdAt: string (date-time)
• createdBy: string
  Example: system
• instanceId(required): string
  Example: besu-instance-1
• organizationNetworkId(required): integer (int64)
  Example: 1
• orgId(required): string
  External organization identifier from orgId.

  Example: default_org
• rpcProxyUrl(required): string
  Maximum Length: 500

  Example: http://rpc-proxy.default.svc:8545
• status(required): string
  Allowed Values: [ "ACTIVE", "INACTIVE" ]

  Example: ACTIVE
• updatedAt: string (date-time)
• updatedBy: string
  Example: system
• walletServiceUrl(required): string
  Maximum Length: 500

  Example: http://obp-besu-wallet-service.default.svc:8080

{
    "type":"object",
    "properties":{
        "organizationNetworkId":{
            "type":"integer",
            "format":"int64",
            "example":1
        },
        "orgId":{
            "type":"string",
            "description":"External organization identifier from orgId.",
            "example":"default_org"
        },
        "accessType":{
            "$ref":"#/components/schemas/OrganizationNetworkAccessType"
        },
        "instanceId":{
            "type":"string",
            "example":"besu-instance-1"
        },
        "blockchainType":{
            "type":"string",
            "maxLength":64,
            "example":"BESU"
        },
        "chainId":{
            "type":"string",
            "maxLength":128,
            "example":"1337"
        },
        "rpcProxyUrl":{
            "type":"string",
            "maxLength":500,
            "example":"http://rpc-proxy.default.svc:8545"
        },
        "walletServiceUrl":{
            "type":"string",
            "maxLength":500,
            "example":"http://obp-besu-wallet-service.default.svc:8080"
        },
        "status":{
            "$ref":"#/components/schemas/OrganizationNetworkStatus"
        },
        "createdBy":{
            "type":"string",
            "nullable":true,
            "example":"system"
        },
        "updatedBy":{
            "type":"string",
            "nullable":true,
            "example":"system"
        },
        "createdAt":{
            "type":"string",
            "format":"date-time",
            "nullable":true
        },
        "updatedAt":{
            "type":"string",
            "format":"date-time",
            "nullable":true
        }
    },
    "required":[
        "organizationNetworkId",
        "orgId",
        "accessType",
        "instanceId",
        "blockchainType",
        "chainId",
        "rpcProxyUrl",
        "walletServiceUrl",
        "status"
    ]
}

400 Response

Bad request.

Body ()

Root Schema : Error

Type: object

Show Source

• details(required): array details
• error(required): string
  Example: Wallet Not Found
• errorCode(required): string
  Example: WALLET_NOT_FOUND
• message(required): string
  Example: Wallet with id 123 was not found.
• path(required): string
  Example: /v1/uwaas/wallets/123
• status(required): integer
  Example: 404
• timestamp(required): string (date-time)
  Example: 2026-07-16T14:23:11.123Z

{
    "type":"object",
    "properties":{
        "timestamp":{
            "type":"string",
            "format":"date-time",
            "example":"2026-07-16T14:23:11.123Z"
        },
        "status":{
            "type":"integer",
            "example":404
        },
        "error":{
            "type":"string",
            "example":"Wallet Not Found"
        },
        "path":{
            "type":"string",
            "example":"/v1/uwaas/wallets/123"
        },
        "errorCode":{
            "type":"string",
            "example":"WALLET_NOT_FOUND"
        },
        "message":{
            "type":"string",
            "example":"Wallet with id 123 was not found."
        },
        "details":{
            "type":"array",
            "items":{
                "type":"string"
            }
        }
    },
    "required":[
        "timestamp",
        "status",
        "error",
        "path",
        "errorCode",
        "message",
        "details"
    ]
}

Nested Schema : details

Type: array

Show Source

• Array of: string

{
    "type":"array",
    "items":{
        "type":"string"
    }
}

500 Response

Internal server error.

Body ()

Root Schema : Error

Type: object

Show Source

• details(required): array details
• error(required): string
  Example: Wallet Not Found
• errorCode(required): string
  Example: WALLET_NOT_FOUND
• message(required): string
  Example: Wallet with id 123 was not found.
• path(required): string
  Example: /v1/uwaas/wallets/123
• status(required): integer
  Example: 404
• timestamp(required): string (date-time)
  Example: 2026-07-16T14:23:11.123Z

{
    "type":"object",
    "properties":{
        "timestamp":{
            "type":"string",
            "format":"date-time",
            "example":"2026-07-16T14:23:11.123Z"
        },
        "status":{
            "type":"integer",
            "example":404
        },
        "error":{
            "type":"string",
            "example":"Wallet Not Found"
        },
        "path":{
            "type":"string",
            "example":"/v1/uwaas/wallets/123"
        },
        "errorCode":{
            "type":"string",
            "example":"WALLET_NOT_FOUND"
        },
        "message":{
            "type":"string",
            "example":"Wallet with id 123 was not found."
        },
        "details":{
            "type":"array",
            "items":{
                "type":"string"
            }
        }
    },
    "required":[
        "timestamp",
        "status",
        "error",
        "path",
        "errorCode",
        "message",
        "details"
    ]
}

Nested Schema : details

Type: array

Show Source

• Array of: string

{
    "type":"array",
    "items":{
        "type":"string"
    }
}

Back to Top