Passer au contenu principal
The CrowdChange API gives you programmatic access to the fundraising platform: campaigns, teams, personal pages, donors, transactions, and webhooks. It is organized into two surfaces:
  • Server Side APIs (/v2/private/...) — for trusted, server-to-server integrations. These return richer data and support write operations such as offline donations and webhook management. Never call them from a browser.
  • Client Side APIs (/v2/client/...) — read-mostly endpoints (plus donation processing) that are safe to call from public-facing pages, such as widgets and custom donation flows.
All requests and responses use JSON, and every request must be made over HTTPS.

​
Base URLs

Use the base URL that matches the region your account is hosted in:
EnvironmentBase URL
Production (US)https://api.crowdchange.co
Production (CA)https://api.crowdchange.ca
Developmenthttps://api.crowdchange.dev

​
Authentication

Every request must include your API key in the Authorization header. The Bearer prefix is optional. 
Authorization: Bearer {api-key}
Your API key identifies your organization (site). Requests without a valid key are rejected with 403 Forbidden. Keep your key secret and use it only from trusted server environments.

​
User authentication

A subset of Server Side endpoints act on behalf of an individual user (for example, managing the campaigns, teams, or personal pages a user owns). These require an additional user token on top of your API key.
  1. Obtain a token by calling Sign In with the user’s credentials.
  2. Send the returned token with each user-specific request, either in the auth-token header or as a token request parameter.
Authorization: Bearer {api-key}
auth-token: {user-token}
User tokens expire after 30 days of inactivity. A user may be signed in on up to 10 devices at once.

​
HTTP Methods

The API follows standard REST conventions:
MethodUsage
GETRetrieve a resource or a list of resources.
POSTCreate a resource, or run a search or an action.
PUTReplace an existing resource with the supplied representation.

​
Dates and Times

All date and time values follow the ISO 8601 standard and are stored and returned in UTC. Date-time values are formatted as YYYY-MM-DD hh:mm:ss.

​
Status Codes

The API uses conventional HTTP status codes to indicate the result of a request:
CodeMeaning
200 OKThe request succeeded.
400 Bad RequestThe request was malformed or could not be processed.
401 UnauthorizedAuthentication is missing or invalid.
403 ForbiddenAuthentication succeeded, but you do not have access to the resource.
404 Not FoundThe requested resource does not exist.
405 Method Not AllowedThe HTTP method is not supported for this endpoint.
422 Unprocessable EntityThe request body failed validation.
429 Too Many RequestsYou have exceeded the rate limit; retry later.

​
Errors

When validation fails (422), the response lists each invalid field and its messages: 
{
  "message": "The given data was invalid.",
  "errors": {
    "fieldname": [
      "Error message"
    ]
  }
}
Other errors return a consistent envelope with a status and a message: 
{
  "status": "error",
  "message": {
    "error": [
      "A description of what went wrong."
    ]
  }
}