Error
A valid request URL is required to generate request examples{
"pageKey": "<string>",
"response": [
{
"id": "<string>",
"slug": "<string>",
"title": "<string>",
"story": "<string>",
"goalUsdAmount": 123,
"status": "active",
"creatorUser": {
"id": "<string>",
"username": "<string>",
"firstName": "<string>",
"lastName": "<string>",
"avatar": "<string>",
"twitter": {
"accountId": "<string>",
"username": "<string>",
"displayName": "<string>",
"avatar": "<string>",
"description": "<string>"
},
"twitch": {
"accountId": "<string>",
"username": "<string>",
"displayName": "<string>",
"avatar": "<string>",
"description": "<string>"
},
"configId": "<string>",
"createdAt": "<string>",
"updatedAt": "<string>"
},
"categoryId": "<string>",
"configId": "<string>",
"createdAt": "<string>",
"updatedAt": "<string>",
"config": {
"id": "<string>",
"feeBps": "<string>",
"developerProjectId": "<string>",
"createdAt": "<string>",
"updatedAt": "<string>",
"supportedChains": [
{
"id": 123,
"name": "<string>",
"type": "bitcoin"
}
],
"userBeneficiaries": [
{
"user": {
"id": "<string>",
"username": "<string>",
"firstName": "<string>",
"lastName": "<string>",
"avatar": "<string>",
"twitter": {
"accountId": "<string>",
"username": "<string>",
"displayName": "<string>",
"avatar": "<string>",
"description": "<string>"
},
"twitch": {
"accountId": "<string>",
"username": "<string>",
"displayName": "<string>",
"avatar": "<string>",
"description": "<string>"
},
"configId": "<string>",
"createdAt": "<string>",
"updatedAt": "<string>"
},
"weight": "<string>"
}
],
"charityBeneficiaries": [
{
"charity": {
"id": "<string>",
"name": "<string>",
"slug": "<string>",
"logo": "<string>",
"website": "<string>",
"mission": "<string>",
"address": "<string>",
"city": "<string>",
"state": "<string>",
"country": "US",
"zipCode": "<string>",
"taxId": "<string>",
"status": "ACTIVE_ONBOARDED",
"configId": "<string>",
"socials": {
"blogUrl": "<string>",
"twitterUrl": "<string>",
"twitterHandle": "<string>",
"facebookUrl": "<string>",
"facebookHandle": "<string>",
"instagramUrl": "<string>",
"instagramHandle": "<string>",
"linkedinUrl": "<string>",
"linkedinHandle": "<string>",
"youtubeUrl": "<string>",
"youtubeHandle": "<string>",
"youtubeChannelId": "<string>"
},
"createdAt": "<string>",
"updatedAt": "<string>"
},
"weight": "<string>"
}
]
},
"category": {
"id": "<string>",
"name": "<string>",
"slug": "<string>",
"imageUrl": "<string>",
"isHot": true,
"createdAt": "<string>",
"updatedAt": "<string>"
},
"media": [
{
"id": "<string>",
"filename": "<string>",
"url": "<string>",
"size": 123,
"mediaType": "image",
"mimeType": "<string>",
"originalMimeType": "<string>",
"userId": "<string>",
"createdAt": "<string>",
"updatedAt": "<string>"
}
],
"stats": {
"pendingUsdE6": "<string>",
"finalizedUsdE6": "<string>",
"displayedUsdE6": "<string>",
"pendingCount": 123,
"finalizedCount": 123,
"donationCount": 123,
"firstDonationAt": "<string>",
"lastDonationAt": "<string>"
}
}
]
}{
"error": "<string>",
"code": "<string>"
}{
"error": "<string>",
"code": "<string>"
}API Reference
List campaigns
List active campaigns. Paginated. Non-active campaigns are not returned.
GET
/
campaigns
Error
A valid request URL is required to generate request examples{
"pageKey": "<string>",
"response": [
{
"id": "<string>",
"slug": "<string>",
"title": "<string>",
"story": "<string>",
"goalUsdAmount": 123,
"status": "active",
"creatorUser": {
"id": "<string>",
"username": "<string>",
"firstName": "<string>",
"lastName": "<string>",
"avatar": "<string>",
"twitter": {
"accountId": "<string>",
"username": "<string>",
"displayName": "<string>",
"avatar": "<string>",
"description": "<string>"
},
"twitch": {
"accountId": "<string>",
"username": "<string>",
"displayName": "<string>",
"avatar": "<string>",
"description": "<string>"
},
"configId": "<string>",
"createdAt": "<string>",
"updatedAt": "<string>"
},
"categoryId": "<string>",
"configId": "<string>",
"createdAt": "<string>",
"updatedAt": "<string>",
"config": {
"id": "<string>",
"feeBps": "<string>",
"developerProjectId": "<string>",
"createdAt": "<string>",
"updatedAt": "<string>",
"supportedChains": [
{
"id": 123,
"name": "<string>",
"type": "bitcoin"
}
],
"userBeneficiaries": [
{
"user": {
"id": "<string>",
"username": "<string>",
"firstName": "<string>",
"lastName": "<string>",
"avatar": "<string>",
"twitter": {
"accountId": "<string>",
"username": "<string>",
"displayName": "<string>",
"avatar": "<string>",
"description": "<string>"
},
"twitch": {
"accountId": "<string>",
"username": "<string>",
"displayName": "<string>",
"avatar": "<string>",
"description": "<string>"
},
"configId": "<string>",
"createdAt": "<string>",
"updatedAt": "<string>"
},
"weight": "<string>"
}
],
"charityBeneficiaries": [
{
"charity": {
"id": "<string>",
"name": "<string>",
"slug": "<string>",
"logo": "<string>",
"website": "<string>",
"mission": "<string>",
"address": "<string>",
"city": "<string>",
"state": "<string>",
"country": "US",
"zipCode": "<string>",
"taxId": "<string>",
"status": "ACTIVE_ONBOARDED",
"configId": "<string>",
"socials": {
"blogUrl": "<string>",
"twitterUrl": "<string>",
"twitterHandle": "<string>",
"facebookUrl": "<string>",
"facebookHandle": "<string>",
"instagramUrl": "<string>",
"instagramHandle": "<string>",
"linkedinUrl": "<string>",
"linkedinHandle": "<string>",
"youtubeUrl": "<string>",
"youtubeHandle": "<string>",
"youtubeChannelId": "<string>"
},
"createdAt": "<string>",
"updatedAt": "<string>"
},
"weight": "<string>"
}
]
},
"category": {
"id": "<string>",
"name": "<string>",
"slug": "<string>",
"imageUrl": "<string>",
"isHot": true,
"createdAt": "<string>",
"updatedAt": "<string>"
},
"media": [
{
"id": "<string>",
"filename": "<string>",
"url": "<string>",
"size": 123,
"mediaType": "image",
"mimeType": "<string>",
"originalMimeType": "<string>",
"userId": "<string>",
"createdAt": "<string>",
"updatedAt": "<string>"
}
],
"stats": {
"pendingUsdE6": "<string>",
"finalizedUsdE6": "<string>",
"displayedUsdE6": "<string>",
"pendingCount": 123,
"finalizedCount": 123,
"donationCount": 123,
"firstDonationAt": "<string>",
"lastDonationAt": "<string>"
}
}
]
}{
"error": "<string>",
"code": "<string>"
}{
"error": "<string>",
"code": "<string>"
}Authorizations
Developer API key. Required for config create/list/delete and project analytics. Optional on public GET reads (anonymous callers are IP rate-limited). Obtain from the Developer dashboard.
Headers
Optional. Omit for the anonymous IP budget (~20 req/min). Keys share their organization billing-tier limit.
Minimum string length:
1Query Parameters
Page size (min 1, max 200)
Required range:
1 <= x <= 200Cursor for next page (from previous pageKey)
Available options:
newest, oldest, total Required string length:
1 - 200Was this page helpful?