Sign in

v31

latestOpenAPI 3.0.0raw.githubusercontent.com2026-07-215985245.8 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 using the connect_id query parameter in any of the List Grants API endpoints.

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

Request body

organization_idstring required

The unique identifier for the organization

namestring

A human readable name of the Connect, optional.

metadataobject

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

Example request

{
  "organization_id": "org_1234567890",
  "contact": {
    "email": "ben.give@co.com",
    "phone": "9127772424",
    "first_name": "Ben",
    "last_name": "Give"
  }
}

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

(deprecated) 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"
}