Get Connect

GET
/v1/connects/:id

Retrieve a connect with the given ID.

Path parameters

idstringRequired

the unique id of the connect

Response

This endpoint returns an object.
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.

namestringOptional

A human readable name for the connect, optional.

activebooleanOptional

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.

createdAtdatetimeOptional

Time when this object was created. Expressed in ISO 8601 format.

updatedAtdatetimeOptional

Time when this object was last updated. Expressed in ISO 8601 format.

createdBystringOptional

ID of the user who created this object.

archivedbooleanOptional

A flag to indicate if this object is marked for deletion.

metadatamap from strings to stringsOptional

A map of arbitrary string keys and values to store information about the object.

Errors

Built with