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

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"
}

Changes

Changed in 4 of the 41 revisions of this API.25545

Jun 29, 2026b87f7738d3361025See the full diff
- ▲
  removed the required property code from the response with the 400 status
  response-required-property-removed
- ▲
  removed the required property code from the response with the 401 status
  response-required-property-removed
- ▲
  removed the required property code from the response with the 403 status
  response-required-property-removed
- ▲
  removed the required property code from the response with the 404 status
  response-required-property-removed
- ▲
  removed the required property code from the response with the 500 status
  response-required-property-removed
- ▲
  removed the required property message from the response with the 400 status
  response-required-property-removed
- ▲
  removed the required property message from the response with the 401 status
  response-required-property-removed
- ▲
  removed the required property message from the response with the 403 status
  response-required-property-removed
- ▲
  removed the required property message from the response with the 404 status
  response-required-property-removed
- ▲
  removed the required property message from the response with the 500 status
  response-required-property-removed
- ○
  media type application/json was changed to a more specific media type application/problem+json for the response status 400
  response-media-type-name-specialized
- ○
  media type application/json was changed to a more specific media type application/problem+json for the response status 401
  response-media-type-name-specialized
- ○
  media type application/json was changed to a more specific media type application/problem+json for the response status 403
  response-media-type-name-specialized
- ○
  media type application/json was changed to a more specific media type application/problem+json for the response status 404
  response-media-type-name-specialized
- ○
  media type application/json was changed to a more specific media type application/problem+json for the response status 500
  response-media-type-name-specialized
- ○
  added the required property detail to the response with the 400 status
  response-required-property-added
- ○
  added the required property detail to the response with the 401 status
  response-required-property-added
- ○
  added the required property detail to the response with the 403 status
  response-required-property-added
- ○
  added the required property detail to the response with the 404 status
  response-required-property-added
- ○
  added the required property detail to the response with the 500 status
  response-required-property-added
- ○
  added the required property status to the response with the 400 status
  response-required-property-added
- ○
  added the required property status to the response with the 401 status
  response-required-property-added
- ○
  added the required property status to the response with the 403 status
  response-required-property-added
- ○
  added the required property status to the response with the 404 status
  response-required-property-added
- ○
  added the required property status to the response with the 500 status
  response-required-property-added
- ○
  added the required property title to the response with the 400 status
  response-required-property-added
- ○
  added the required property title to the response with the 401 status
  response-required-property-added
- ○
  added the required property title to the response with the 403 status
  response-required-property-added
- ○
  added the required property title to the response with the 404 status
  response-required-property-added
- ○
  added the required property title to the response with the 500 status
  response-required-property-added
- ○
  added the required property type to the response with the 400 status
  response-required-property-added
- ○
  added the required property type to the response with the 401 status
  response-required-property-added
- ○
  added the required property type to the response with the 403 status
  response-required-property-added
- ○
  added the required property type to the response with the 404 status
  response-required-property-added
- ○
  added the required property type to the response with the 500 status
  response-required-property-added
This revision also has 1 change that name no endpoint, such as unreferenced schemas being removed. See the revision's changelog
Jun 29, 2026c65f43c5ad905See the full diff
- ●
  removed the optional property details from the response with the 400 status
  response-optional-property-removed
- ●
  removed the optional property details from the response with the 401 status
  response-optional-property-removed
- ●
  removed the optional property details from the response with the 403 status
  response-optional-property-removed
- ●
  removed the optional property details from the response with the 404 status
  response-optional-property-removed
- ●
  removed the optional property details from the response with the 500 status
  response-optional-property-removed
Jun 25, 2026f89b4f376e9415See the full diff
- ○
  added the optional property details/items/debug to the response with the 400 status
  response-optional-property-added
- ○
  added the optional property details/items/debug to the response with the 401 status
  response-optional-property-added
- ○
  added the optional property details/items/debug to the response with the 403 status
  response-optional-property-added
- ○
  added the optional property details/items/debug to the response with the 404 status
  response-optional-property-added
- ○
  added the optional property details/items/debug to the response with the 500 status
  response-optional-property-added
- ○
  added the optional property details/items/type to the response with the 400 status
  response-optional-property-added
- ○
  added the optional property details/items/type to the response with the 401 status
  response-optional-property-added
- ○
  added the optional property details/items/type to the response with the 403 status
  response-optional-property-added
- ○
  added the optional property details/items/type to the response with the 404 status
  response-optional-property-added
- ○
  added the optional property details/items/type to the response with the 500 status
  response-optional-property-added
- ○
  added the optional property details/items/value to the response with the 400 status
  response-optional-property-added
- ○
  added the optional property details/items/value to the response with the 401 status
  response-optional-property-added
- ○
  added the optional property details/items/value to the response with the 403 status
  response-optional-property-added
- ○
  added the optional property details/items/value to the response with the 404 status
  response-optional-property-added
- ○
  added the optional property details/items/value to the response with the 500 status
  response-optional-property-added
Jun 25, 202690671617b825155See the full diff
- ▲
  the code response's property type/format changed from number/ to string/ for status 400
  response-property-type-changed
- ▲
  the code response's property type/format changed from number/ to string/ for status 401
  response-property-type-changed
- ▲
  the code response's property type/format changed from number/ to string/ for status 403
  response-property-type-changed
- ▲
  the code response's property type/format changed from number/ to string/ for status 404
  response-property-type-changed
- ▲
  the code response's property type/format changed from number/ to string/ for status 500
  response-property-type-changed
- ▲
  removed the required property error from the response with the 400 status
  response-required-property-removed
- ▲
  removed the required property error from the response with the 401 status
  response-required-property-removed
- ▲
  removed the required property error from the response with the 403 status
  response-required-property-removed
- ▲
  removed the required property error from the response with the 404 status
  response-required-property-removed
- ▲
  removed the required property error from the response with the 500 status
  response-required-property-removed
- ▲
  removed the required property timestamp from the response with the 400 status
  response-required-property-removed
- ▲
  removed the required property timestamp from the response with the 401 status
  response-required-property-removed
- ▲
  removed the required property timestamp from the response with the 403 status
  response-required-property-removed
- ▲
  removed the required property timestamp from the response with the 404 status
  response-required-property-removed
- ▲
  removed the required property timestamp from the response with the 500 status
  response-required-property-removed
- ○
  added the optional property details to the response with the 400 status
  response-optional-property-added
- ○
  added the optional property details to the response with the 401 status
  response-optional-property-added
- ○
  added the optional property details to the response with the 403 status
  response-optional-property-added
- ○
  added the optional property details to the response with the 404 status
  response-optional-property-added
- ○
  added the optional property details to the response with the 500 status
  response-optional-property-added
This revision also has 1 change that name no endpoint, such as unreferenced schemas being removed. See the revision's changelog

Full history