GET/v1/global-connections

List global connections

Lists global connections and their status, with optional filters for scope, piece name, and display name. Supply the required status values to select connections in ACTIVE, MISSING, or ERROR states, and use cursor and limit to navigate results.

6 parameters
cursorstringoptional
The cursor used to retrieve a page of global connections.
scopestringoptional
Filter connections by scope: PROJECT or PLATFORM.
Allowed:PROJECTPLATFORM
pieceNamestringoptional
Filter connections by piece name.
displayNamestringoptional
Filter connections by display name.
statusarray<string>required
Filter by connection status. Supply an array containing ACTIVE, MISSING, or ERROR values.
limitnumberoptional
The numeric limit for the number of global connections to request.

1 status code
200Returns an object containing global connection records in `data` and optional `next` and `previous` pagination cursors.
dataarray<object>required
nextstringoptional
previousstringoptional

Error handling

The status query parameter is required and accepts an array of ACTIVE, MISSING, or ERROR values. If provided, scope must be PROJECT or PLATFORM. Use cursor and limit to navigate or size the result page.