CHchariot-giving
Connects

Get Connect

Retrieve a connect with the given ID.

get/v1/connects/{id}

Request

  • Base URL
    https://sandboxapi.givechariot.com
  • URL
    https://sandboxapi.givechariot.com/v1/connects/{id}
  • Auth
    HTTP bearer

Path parameters

idstring required

the unique id of the connect

Response

OK

idstring required

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

namestring

A human readable name for the connect, optional.

activeboolean

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.

createdAtstring date-time

Time when this object was created. Expressed in RFC 3339 format.

updatedAtstring date-time

Time when this object was last updated. Expressed in RFC 3339 format.

createdBystring

ID of the user who created this object.

archivedboolean

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

metadataobject

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

Example response

{
  "id": "test_connect123",
  "name": "website",
  "active": true,
  "createdAt": "2020-01-31T23:00:00Z",
  "updatedAt": "2020-01-31T23:59:59Z",
  "createdBy": "auth0-user-id-123"
}

Changes

No recorded changes to this operation across all 12 revisions of this API.