Sign in
latestOpenAPI 3.0.32026-08-224982,0272.8 MB

e445c15e5bee

Client Activation

List client connections

List all your Go network connections. For use only by OES clients.

Error scenarios:

  • 400: Invalid Request Error

  • Occurs when the request parameters are invalid or malformed.

  • Examples: Invalid UUID format for enterpriseId, invalid filter parameters, invalid pagination parameters, invalid partner IDs.

  • 401: Authentication Error

  • Occurs when the request is not authorized.

  • Examples: Missing or invalid auth token, expired credentials.

  • 403: Permission Denied Error

  • Occurs when the authenticated client doesn't have necessary permissions.

  • Examples: Client not authorized for this enterprise, client doesn't have permission to view connections.

  • 404: Not Found Error

  • Occurs when the specified enterprise cannot be found.

  • Examples: Enterprise ID doesn't exist or doesn't belong to the client.

  • 500: Internal Server Error

  • Occurs when there's an unexpected server error processing the request.

  • Examples: Database connection issues, error retrieving connection data.

Requires access token scope: settlement_network_read

get/api/network/v1/enterprises/{enterpriseId}/clients/connections

Path parameters

enterpriseIdstring required

Query parameters

pageNumberstring integer

The page number (integer) you wish to fetch. When provided, the API will skip pageSize * pageNumber records. Page numbers are zero-based, so the first page is 0. If not provided, defaults to 0.

pageSizestring

The page size (integer) you wish to fetch. When provided, the API will return at most pageSize records per page. If not provided, a default page size defined by the server will be used.

activeboolean
connectionIdsstring[]
namesstring[]
partnerIdsstring[]

Response

OK