v1

latestOpenAPI 3.1.02026-07-24770322.0 KB

List App Connections

This endpoint lists all app connections for the specified manual app install within the workspace.

get/v1/installs/{installId}/connections

Path parameters

installIdstring required

Query parameters

clientIdstring

If specified, only app connections that are visible to this client will be returned

companyIdstring

If specified, only app connections that are associated with this company will be returned

Response

200

clientIdsstring[]
{"stackTrail":"paths:/v1/installs/{installId}/connections:get:responses:200:content:application/json:schema:items:properties:companyId","oasType":"schema","type":"unknown"}
contentstring
createdAtstring
idstring
installIdstring
membershipTypestring
objectstring
typestring
updatedAtstring

Example response

[
  {
    "clientIds": [
      "6607c487-199d-4c9a-b3e1-f4491bc29ddf"
    ],
    "content": "https://specific-link1.com",
    "createdAt": "2024-03-29T16:41:54.267514747Z",
    "id": "9ca3f6bb-ddb2-4007-8206-021cfbb39475",
    "installId": "21e21a4e-6bbb-47d0-a9bd-c4e99a3ca9a2",
    "membershipType": "individual",
    "object": "appConnection",
    "type": "link"
  }
]