Error
A valid request URL is required to generate request examples{
"id": {
"hex": "<string>",
"base58": "<string>"
},
"feeBps": "<string>",
"users": [
{
"id": "<string>",
"weight": "<string>"
}
],
"charities": [
{
"id": "<string>",
"slug": "<string>",
"name": "<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": {
"blog": "<string>",
"twitter": "<string>",
"facebook": "<string>",
"instagram": "<string>",
"linkedin": "<string>",
"youtube": "<string>",
"blogUrl": "<string>",
"twitterUrl": "<string>",
"twitterHandle": "<string>",
"facebookUrl": "<string>",
"facebookHandle": "<string>",
"instagramUrl": "<string>",
"instagramHandle": "<string>",
"linkedinUrl": "<string>",
"linkedinHandle": "<string>",
"youtubeUrl": "<string>",
"youtubeHandle": "<string>",
"youtubeChannelId": "<string>"
},
"isEnabled": true,
"weight": "<string>",
"stats": {
"pendingUsdE6": "<string>",
"finalizedUsdE6": "<string>",
"displayedUsdE6": "<string>",
"pendingCount": 0,
"finalizedCount": 0,
"donationCount": 0,
"firstDonationAt": "<string>",
"lastDonationAt": "<string>"
}
}
]
}{
"defined": true,
"code": "VALIDATION_ERROR",
"status": 400,
"message": "Validation failed",
"data": {
"error": "<string>",
"code": "VALIDATION_ERROR",
"issues": [
null
]
}
}{
"defined": true,
"code": "NOT_FOUND",
"status": 404,
"message": "Not found",
"data": {
"error": "<string>",
"code": "NOT_FOUND"
}
}API Reference
Get a config by id
Get a config with its user and charity beneficiaries. Public: any caller may inspect a config by id (Core-scoped). API key is optional.
GET
/
v1
/
configs
/
{configId}
Error
A valid request URL is required to generate request examples{
"id": {
"hex": "<string>",
"base58": "<string>"
},
"feeBps": "<string>",
"users": [
{
"id": "<string>",
"weight": "<string>"
}
],
"charities": [
{
"id": "<string>",
"slug": "<string>",
"name": "<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": {
"blog": "<string>",
"twitter": "<string>",
"facebook": "<string>",
"instagram": "<string>",
"linkedin": "<string>",
"youtube": "<string>",
"blogUrl": "<string>",
"twitterUrl": "<string>",
"twitterHandle": "<string>",
"facebookUrl": "<string>",
"facebookHandle": "<string>",
"instagramUrl": "<string>",
"instagramHandle": "<string>",
"linkedinUrl": "<string>",
"linkedinHandle": "<string>",
"youtubeUrl": "<string>",
"youtubeHandle": "<string>",
"youtubeChannelId": "<string>"
},
"isEnabled": true,
"weight": "<string>",
"stats": {
"pendingUsdE6": "<string>",
"finalizedUsdE6": "<string>",
"displayedUsdE6": "<string>",
"pendingCount": 0,
"finalizedCount": 0,
"donationCount": 0,
"firstDonationAt": "<string>",
"lastDonationAt": "<string>"
}
}
]
}{
"defined": true,
"code": "VALIDATION_ERROR",
"status": 400,
"message": "Validation failed",
"data": {
"error": "<string>",
"code": "VALIDATION_ERROR",
"issues": [
null
]
}
}{
"defined": true,
"code": "NOT_FOUND",
"status": 404,
"message": "Not found",
"data": {
"error": "<string>",
"code": "NOT_FOUND"
}
}Authorizations
Developer API key. Required for config create/list and project analytics. The disabled config DELETE endpoint also requires authentication. Optional on public GET reads (anonymous callers are IP rate-limited). Obtain from the Developer dashboard.
Path Parameters
Config ID (base58 or hex)
Was this page helpful?