ByteChef LogoByteChef
Backend (API Key)Connections

Get all connected user's connections

Get all connected user's connections.

GET
/{externalUserId}/components/{componentName}/connections

Authorization

bearerAuth
AuthorizationBearer <token>

In: header

Path Parameters

externalUserId*string

The external user id.

componentName*string

The component name.

Query Parameters

connectionIds?array<>

The list of allowed connection ids.

Header Parameters

X-Environment?string

The environment.

Value in

  • "DEVELOPMENT"
  • "STAGING"
  • "PRODUCTION"

Response Body

application/json

curl -X GET "https://example.com/string/components/string/connections"
[  {    "id": 0,    "name": "string",    "environment": "DEVELOPMENT"  }]

How is this guide?

Embedded Connections

List, delete and reauthorize a connected user's connections.

Embedded Connected Users

Update a connected user.