Sign in

v13

latestOpenAPI 3.0.0raw.githubusercontent.com2026-06-29231692.6 KB
Connects

Create Connect

Get an existing connect or create a new connect for an existing nonprofit organization.

The returned Connect can be used to integrate the client-side Chariot Connect component using the id property (CID) and also query for data generated from the Chariot Connect instance from the Chariot API using the x-chariot-api-key header parameter.

<Note> Only one Connect object can be created per Nonprofit. If one already exists, this will return a `200 OK` status with the existing object. </Note>
post/v1/connects

Query parameters

nonprofitstring uuid required

The unique id of the nonprofit. The format should be a v4 UUID according to RFC 4122.

suborganizationstring uuid

The unique id for the suborganization within the nonprofit. The format should be a v4 UUID according to RFC 4122.

Request body

namestring

A human readable name of the Connect, optional.

metadataobject

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

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.

apiKeystring required

A secure token that can be used to make M2M API calls to read data generated by this object.

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",
  "apiKey": "test_apiTokenABC",
  "active": true,
  "createdAt": "2020-01-31T23:00:00Z",
  "updatedAt": "2020-01-31T23:59:59Z",
  "createdBy": "auth0-user-id-123"
}