latestSwagger 2.0BSD License2026-08-107753105.4 KB

52b0eb5e8b96

profile

Connections

Lists the connections available for a profile and their "state". This endpoint returns a list of objects.

get/profile/{public_id}/connections/

Query parameters

redirectstring

After connecting redirect back to this url.

Note: has to be a valid http url. For deeplinks (to apps) first redirect to your own backend and then deeplink from there.

Note: the user is only redirected on a successfull connection, otherwise an error screen is shown. (see redirect_on_error to change this)

Note: if this parameter is omitted, then user will see a generic success screen.

redirect_on_errorboolean

If enabled, then user will also be redirected to the redirect url if an error occurs

Note: a query parameter 'error' is added to the redirect url. Possible values are access_denied, unknown. New values may be added at anytime

Note: for backwards compatibility the default is false, but this will be changed in the next breaking release

Response

OK

display_namestring
urlstring
connectedboolean
connection_slugstring
img_urlstring
created_atstring date-time
updated_atstring date-time