Get Connect

Retrieve a connect with the given ID.

Path parameters

idstringRequired
the unique id of the connect

Headers

AuthorizationstringRequired

Bearer authentication of the form Bearer <token>, where token is your auth token.

Response

OK
idstring

The unique identifier for this object. This is also the ‘publishable’ cid to use for initializing Connect for client-side integration.

apiKeystring
A secure token that can be used to make M2M API calls to read data generated by this object.
namestring or null
A human readable name for the connect, optional.
activeboolean or null
A flag to indicate if this connect is active. If true, then this Connect can process donations and grants, otherwise this Connect cannot process grants.
createdAtdatetime or null
Time when this object was created. Expressed in ISO 8601 format.
updatedAtdatetime or null
Time when this object was last updated. Expressed in ISO 8601 format.
createdBystring or null
ID of the user who created this object.
archivedboolean or null
A flag to indicate if this object is marked for deletion.
metadatamap from strings to strings or null
A map of arbitrary string keys and values to store information about the object.

Errors