/{connector_id}/connected_info

Gets the connected info of a connector given.

This operation retrieves the connected info of a connector given the credentials and settings. This is only used if the connector has aspects of it's info response that change based on the credentials and settings.

IMPORTANT: This only need to be implemented if the connector has elements of it's info response that are dependent on the credentials and settings. Examples:

  • A connector that only has the ability to suspend accounts if given a write capable api token
  • A connector that has resource types that can only be determined via an api call

If not implemented, the static info response can be used.

This endpoint should be called:

  • Any time you need an element of the info response and the connector implements this capability
Recent Requests
Log in to see full request history
TimeStatusUser Agent
Retrieving recent requests…
LoadingLoading…
Path Params
string
required
Body Params
auth
object

Authentication credentials, which can be one of several types.

credentials
array of objects
credentials
request
object
required

This is a hack to force creation of types that extend this model, that otherwise don't have any properties but we still want the Python types for.

boolean

Whether to include raw data in the response.

page
object

Pagination parameters for requests and responses.

settings
object

Connector-specific settings for the request.

These are settings that are shared across all capabilities.

Usually contain additional required configuration options not specified by the capability schema.

Response

Language
LoadingLoading…
Response
Click Try It! to start a request and see the response here! Or choose an example:
application/json