Get connector

Fetch the connector for a host, cookies included, ready for a run to inject. A host with no connector of its own is served by its nearest parent's, and a host with neither is a 404. When the site holds several connectors for the profile, name one with account or label (an empty label for the one without a label).

get/api/connectors/{host}

Request

  • Base URL: https://reduck.ai
  • URL: https://reduck.ai/api/connectors/{host}
  • Auth: one of:
    • HTTP bearer
    • API key in header X-API-Key

Path parameters

hoststring required

Query parameters

profilestring

The end-user this connector is kept for, in your own naming (for example your user id). Omit, or leave empty, for your own account's connectors. Only an API key or an OAuth token can read or create an end-user's connector.

accountstring

The connector whose account (as its probe or SSO sign-in reported it) is this one.

labelstring

The connector with this label, or "" for the one without a label.

Response

OK

idstring required
hoststring required

The website, bare: no scheme, no leading "www.", e.g. "linkedin.com". For an SSO connector this is the identity provider, e.g. "accounts.google.com".

profile_idstring required

The end-user this connector is kept for, as the developer named them. Empty for the account's own connectors.

accountstring nullable required

The identity a probe script or the SSO sign-in reported (usually an email). Null until one has; it is never set by hand.

labelstring nullable required

The name a person gave this connector, to tell it apart from the host's others.

is_ssoboolean required

True when this is an identity-provider session usable for "Continue with <provider>".

sso_accountstring nullable required

For a connector created through an SSO connector: that SSO's account (email). The reference autoreconnect follows. Null otherwise.

created_atstring required
updated_atstring required

Changes

No recorded changes to this operation across all 1 revision of this API.