Skip to main content
API docs by Redocly

V5ApiCause (1.0)

Download OpenAPI specification:Download

fundraising_event

List top fundraisers by fundraising_event_id

Authorizations:
authorization
path Parameters
fundraising_event_id
required
string

Fundraising Event ID

query Parameters
time_type
string
Enum: "daily" "weekly" "monthly" "yearly" "ytd" "all" "custom"
Example: time_type=all

The time range to use in leaderboard generation

after
string

Returns records after the given cursor

before
string

Returns records before the given cursor

limit
integer [ 1 .. 100 ]
Default: 10

Responses

Response samples

Content type
application/json
{
  • "data": [],
  • "metadata": {
    }
}

List configured leaderboards by fundraising_event_id Deprecated

Authorizations:
authorization
path Parameters
fundraising_event_id
required
string

fundraising event id

Responses

Response samples

Content type
application/json
{
  • "data": {
    }
}

List fundraising_event registrations by fundraising_event ID

Authorizations:
authorization
path Parameters
fundraising_event_id
required
string

FundraisingEvent ID or legacy ID

query Parameters
after
string

Returns records after the given cursor

before
string

Returns records before the given cursor

limit
integer [ 1 .. 100 ]
Default: 10

Responses

Response samples

Content type
application/json
{
  • "data": [
    ],
  • "metadata": {
    }
}

List top teams by fundraising_event_id

Authorizations:
authorization
path Parameters
fundraising_event_id
required
string

Fundraising Event ID

query Parameters
time_type
string
Enum: "daily" "weekly" "monthly" "yearly" "ytd" "all" "custom"
Example: time_type=all

The time range to use in leaderboard generation

after
string

Returns records after the given cursor

before
string

Returns records before the given cursor

limit
integer [ 1 .. 100 ]
Default: 10

Responses

Response samples

Content type
application/json
{
  • "data": [],
  • "metadata": {
    }
}

List fundraising_events

Lists the current cause fundraising_events

Authorizations:
authorization
query Parameters
starts_after
string
Example: starts_after=2021-11-02T14:24:55.811924Z

Returns only fundraising_events that have been starts after the given moment in ISO8601 format

starts_before
string
Example: starts_before=2021-11-02T14:24:55.811924Z

Returns only fundraising_events that have been starts before the given moment in ISO8601 format

status
string
Enum: "published" "retired" "unpublished"
Example: status=published

Use this parameter to filter fundraising_events by the given status.

updated_after
string
Example: updated_after=2021-11-02T14:24:55.811924Z

Returns only fundraising_events that have been updated after the given moment in ISO8601 format

updated_before
string
Example: updated_before=2021-11-02T14:24:55.811924Z

Returns only fundraising_events that have been updated before the given moment in ISO8601 format

after
string

Returns records after the given cursor

before
string

Returns records before the given cursor

limit
integer [ 1 .. 100 ]
Default: 10

Responses

Response samples

Content type
application/json
{
  • "data": [
    ],
  • "metadata": {
    }
}

List fundraising_event rewards by fundraising_event ID

Authorizations:
authorization
path Parameters
fundraising_event_id
required
string

FundraisingEvent ID or legacy ID

query Parameters
after
string

Returns records after the given cursor

before
string

Returns records before the given cursor

limit
integer [ 1 .. 100 ]
Default: 10

Responses

Response samples

Content type
application/json
{
  • "data": [
    ],
  • "metadata": {
    }
}

List top teams fitness distances by fundraising_event_id

Authorizations:
authorization
path Parameters
fundraising_event_id
required
string

Fundraising Event ID

query Parameters
time_type
string
Enum: "daily" "weekly" "monthly" "yearly" "ytd" "all" "custom"
Example: time_type=all

The time range to use in leaderboard generation

after
string

Returns records after the given cursor

before
string

Returns records before the given cursor

limit
integer [ 1 .. 100 ]
Default: 10

Responses

Response samples

Content type
application/json
{
  • "data": [],
  • "metadata": {
    }
}

List fundraising_event incentives by fundraising_event ID

Authorizations:
authorization
path Parameters
fundraising_event_id
required
string

FundraisingEvent ID or legacy ID

query Parameters
after
string

Returns records after the given cursor

before
string

Returns records before the given cursor

limit
integer [ 1 .. 100 ]
Default: 10

Responses

Response samples

Content type
application/json
{
  • "data": [
    ],
  • "metadata": {
    }
}

List fundraising_event donations by fundraising_event ID

Authorizations:
authorization
path Parameters
fundraising_event_id
required
string

FundraisingEvent ID or legacy ID

query Parameters
completed_after
string
Example: completed_after=2021-11-02T14:24:55.811924Z

Returns only donations that have been completed after the given moment in ISO8601 format

completed_before
string
Example: completed_before=2021-11-02T14:24:55.811924Z

Returns only donations that have been completed before the given moment in ISO8601 format

created_after
string
Example: created_after=2021-11-02T14:24:55.811924Z

Returns only donations that have been created after the given moment in ISO8601 format

created_before
string
Example: created_before=2021-11-02T14:24:55.811924Z

Returns only donations that have been created before the given moment in ISO8601 format

updated_after
string
Example: updated_after=2021-11-02T14:24:55.811924Z

Returns only donations that have been updated after the given moment in ISO8601 format

updated_before
string
Example: updated_before=2021-11-02T14:24:55.811924Z

Returns only donations that have been updated before the given moment in ISO8601 format

after
string

Returns records after the given cursor

before
string

Returns records before the given cursor

limit
integer [ 1 .. 100 ]
Default: 10

Responses

Response samples

Content type
application/json
{
  • "data": [
    ],
  • "metadata": {
    }
}

Get Fundraising Event by ID

Returns a Fundraising Event by its ID

Authorizations:
authorization
path Parameters
fundraising_event_id
required
string

Fundraising Event ID

Responses

Response samples

Content type
application/json
{
  • "data": {
    }
}

List top users fitness distances by fundraising_event_id

Authorizations:
authorization
path Parameters
fundraising_event_id
required
string

Fundraising Event ID

query Parameters
time_type
string
Enum: "daily" "weekly" "monthly" "yearly" "ytd" "all" "custom"
Example: time_type=all

The time range to use in leaderboard generation

after
string

Returns records after the given cursor

before
string

Returns records before the given cursor

limit
integer [ 1 .. 100 ]
Default: 10

Responses

Response samples

Content type
application/json
{
  • "data": [],
  • "metadata": {
    }
}

List top teams fitness times by fundraising_event_id

Authorizations:
authorization
path Parameters
fundraising_event_id
required
string

Fundraising Event ID

query Parameters
time_type
string
Enum: "daily" "weekly" "monthly" "yearly" "ytd" "all" "custom"
Example: time_type=all

The time range to use in leaderboard generation

after
string

Returns records after the given cursor

before
string

Returns records before the given cursor

limit
integer [ 1 .. 100 ]
Default: 10

Responses

Response samples

Content type
application/json
{
  • "data": [],
  • "metadata": {
    }
}

List top users fitness times by fundraising_event_id

Authorizations:
authorization
path Parameters
fundraising_event_id
required
string

Fundraising Event ID

query Parameters
time_type
string
Enum: "daily" "weekly" "monthly" "yearly" "ytd" "all" "custom"
Example: time_type=all

The time range to use in leaderboard generation

after
string

Returns records after the given cursor

before
string

Returns records before the given cursor

limit
integer [ 1 .. 100 ]
Default: 10

Responses

Response samples

Content type
application/json
{
  • "data": [],
  • "metadata": {
    }
}

List fundraising event supporting events

Authorizations:
authorization
path Parameters
fundraising_event_id
required
string

FundraisingEvent ID or legacy ID

query Parameters
status
string
Enum: "published" "retired" "unpublished"
Example: status=published

Use this parameter to filter events by the given status.

updated_after
string
Example: updated_after=2021-11-02T14:24:55.811924Z

Returns only events that have been updated after the given moment in ISO8601 format

updated_before
string
Example: updated_before=2021-11-02T14:24:55.811924Z

Returns only events that have been updated before the given moment in ISO8601 format

after
string

Returns records after the given cursor

before
string

Returns records before the given cursor

limit
integer [ 1 .. 100 ]
Default: 10

Responses

Response samples

Content type
application/json
{
  • "data": [
    ],
  • "metadata": {
    }
}

List top donors by fundraising_event_id

Authorizations:
authorization
path Parameters
fundraising_event_id
required
string

Fundraising Event ID

query Parameters
time_type
string
Enum: "daily" "weekly" "monthly" "yearly" "ytd" "all" "custom"
Example: time_type=all

The time range to use in leaderboard generation

after
string

Returns records after the given cursor

before
string

Returns records before the given cursor

limit
integer [ 1 .. 100 ]
Default: 10

Responses

Response samples

Content type
application/json
{
  • "data": [],
  • "metadata": {
    }
}

team_campaign

Get team campaign by ID

Returns a Team Campaign by its ID

Authorizations:
authorization
path Parameters
team_campaign_id
required
string

Team Campaign ID

Responses

Response samples

Content type
application/json
{
  • "data": {
    }
}

List campaigns supporting a Team Campaign

Authorizations:
authorization
path Parameters
team_campaign_id
required
string

Team Campaign ID

query Parameters
after
string

Returns records after the given cursor

before
string

Returns records before the given cursor

limit
integer [ 1 .. 100 ]
Default: 10

Responses

Response samples

Content type
application/json
{
  • "data": [
    ],
  • "metadata": {
    }
}

List Team Campaign donations by Team Campaign ID

Authorizations:
authorization
path Parameters
team_campaign_id
required
string

Team Campaign ID or legacy ID

query Parameters
completed_after
string
Example: completed_after=2021-11-02T14:24:55.811924Z

Returns only donations that have been completed after the given moment in ISO8601 format

completed_before
string
Example: completed_before=2021-11-02T14:24:55.811924Z

Returns only donations that have been completed before the given moment in ISO8601 format

created_after
string
Example: created_after=2021-11-02T14:24:55.811924Z

Returns only team_campaigns that have been created after the given moment in ISO8601 format

created_before
string
Example: created_before=2021-11-02T14:24:55.811924Z

Returns only team_campaigns that have been created before the given moment in ISO8601 format

updated_after
string
Example: updated_after=2021-11-02T14:24:55.811924Z

Returns only team_campaigns that have been updated after the given moment in ISO8601 format

updated_before
string
Example: updated_before=2021-11-02T14:24:55.811924Z

Returns only team_campaigns that have been updated before the given moment in ISO8601 format

after
string

Returns records after the given cursor

before
string

Returns records before the given cursor

limit
integer [ 1 .. 100 ]
Default: 10

Responses

Response samples

Content type
application/json
{
  • "data": [
    ],
  • "metadata": {
    }
}

List top donors

Authorizations:
authorization
path Parameters
team_campaign_id
required
string

Team Campaign ID

query Parameters
time_type
string
Enum: "daily" "weekly" "monthly" "yearly" "ytd" "all"
Example: time_type=all

The time range to use in leaderboard generation

after
string

Returns records after the given cursor

before
string

Returns records before the given cursor

limit
integer [ 1 .. 100 ]
Default: 10

Responses

Response samples

Content type
application/json
{
  • "data": [],
  • "metadata": {
    }
}

List Team Campaign targets by Team Campaign ID

Authorizations:
authorization
path Parameters
team_campaign_id
required
string

Team Campaign ID or legacy ID

query Parameters
after
string

Returns records after the given cursor

before
string

Returns records before the given cursor

limit
integer [ 1 .. 100 ]
Default: 10

Responses

Response samples

Content type
application/json
{
  • "data": [
    ],
  • "metadata": {
    }
}

List Team Campaign schedules by Team Campaign ID

Authorizations:
authorization
path Parameters
team_campaign_id
required
string

Team Campaign ID or legacy ID

query Parameters
after
string

Returns records after the given cursor

before
string

Returns records before the given cursor

limit
integer [ 1 .. 100 ]
Default: 10

Responses

Response samples

Content type
application/json
{
  • "data": [
    ],
  • "metadata": {
    }
}

Get team campaign by team slug and campaign slug

Returns a Team Campaign by its team slug and campaign slug

Authorizations:
authorization
path Parameters
team_slug
required
string

Team Slug

team_campaign_slug
required
string

Campaign Slug

Responses

Response samples

Content type
application/json
{
  • "data": {
    }
}

List Team Campaigns

Lists the current cause Team Campaigns

Authorizations:
authorization
query Parameters
status
string
Enum: "published" "retired" "unpublished"
Example: status=published

Use this parameter to filter Team Campaigns by the given status.

supporting_type
string
Enum: "invite_only" "none" "private" "public"
Example: supporting_type=public

Use this parameter to filter Team Campaigns by the given supporting type.

updated_after
string
Example: updated_after=2021-11-02T14:24:55.811924Z

Returns only Team Campaigns that have been updated after the given moment in ISO8601 format

updated_before
string
Example: updated_before=2021-11-02T14:24:55.811924Z

Returns only Team Campaigns that have been updated before the given moment in ISO8601 format

team_id
string
Example: team_id=197760e6-fb57-4a71-81d7-5cf7366c4261

Filter the given campaigns by a team id or legacy id

after
string

Returns records after the given cursor

before
string

Returns records before the given cursor

limit
integer [ 1 .. 100 ]
Default: 10

Responses

Response samples

Content type
application/json
{
  • "data": [
    ],
  • "metadata": {
    }
}

List top users

Authorizations:
authorization
path Parameters
team_campaign_id
required
string

Team Campaign ID

query Parameters
time_type
string
Enum: "daily" "weekly" "monthly" "yearly" "ytd" "all"
Example: time_type=all

The time range to use in leaderboard generation

after
string

Returns records after the given cursor

before
string

Returns records before the given cursor

limit
integer [ 1 .. 100 ]
Default: 10

Responses

Response samples

Content type
application/json
{
  • "data": [],
  • "metadata": {
    }
}

List Team Campaign polls by Team Campaign ID

Authorizations:
authorization
path Parameters
team_campaign_id
required
string

Team Campaign ID or legacy ID

query Parameters
after
string

Returns records after the given cursor

before
string

Returns records before the given cursor

limit
integer [ 1 .. 100 ]
Default: 10

Responses

Response samples

Content type
application/json
{
  • "data": [
    ],
  • "metadata": {
    }
}

List Team Campaign rewards by Team Campaign ID

Authorizations:
authorization
path Parameters
team_campaign_id
required
string

Team Campaign ID or legacy ID

query Parameters
after
string

Returns records after the given cursor

before
string

Returns records before the given cursor

limit
integer [ 1 .. 100 ]
Default: 10

Responses

Response samples

Content type
application/json
{
  • "data": [
    ],
  • "metadata": {
    }
}

List milestones

Authorizations:
authorization
path Parameters
team_campaign_id
required
string

Team Campaign ID or legacy ID

query Parameters
include_disabled
boolean
Example: include_disabled=true

Returns disabled milestones. Defaults to false

created_before
string
Example: created_before=2021-11-02T14:24:55.811924Z

Returns only milestones that have been updated before the given moment in ISO8601 format

created_after
string
Example: created_after=2021-11-02T14:24:55.811924Z

Returns only milestones that have been updated after the given moment in ISO8601 format

updated_before
string
Example: updated_before=2021-11-02T14:24:55.811924Z

Returns only milestones that have been updated before the given moment in ISO8601 format

updated_after
string
Example: updated_after=2021-11-02T14:24:55.811924Z

Returns only milestones that have been updated after the given moment in ISO8601 format

after
string

Returns records after the given cursor

before
string

Returns records before the given cursor

limit
integer [ 1 .. 100 ]
Default: 10

Responses

Response samples

Content type
application/json
{
  • "data": [
    ],
  • "metadata": {
    }
}

oauth

Token

Returns an access and refresh token with a provided client id, secret, and grant type. Tokens expire in 7200 seconds.

Authorizations:
authorization
query Parameters
client_id
required
string

Client Id

client_secret
required
string

Client Secret

grant_type
required
string
Default: "client_credentials"
Enum: "client_credentials" "authorization_code" "refresh_token"

Grant Type

code
string

Authorization Code; *required if using authorization_code grant type

refresh_token
string

Refresh Token; *required if using refresh_token grant type

scope
string
Default: "cause"
Enum: "public" "cause"

Scope

Responses

Response samples

Content type
application/json
{
  • "access_token": "ab6a592346444dea97170837e104d8a5ab6a592346444dea97170837e104d8a5",
  • "created_at": "2023-01-27T19:32:03Z",
  • "expires_in": 7200,
  • "refresh_token": "njjjytm3otetmgrjmi00yjawlwe4zgytzjixy2mzm2y3njawcg121231999393a3",
  • "scope": "cause",
  • "token_type": "bearer"
}

campaign

List campaigns

Lists the current cause campaigns

Authorizations:
authorization
query Parameters
status
string
Enum: "published" "retired" "unpublished"
Example: status=published

Use this parameter to filter campaigns by the given status.

supporting_type
string
Enum: "invite_only" "none" "private" "public"
Example: supporting_type=public

Use this parameter to filter campaigns by the given supporting type.

updated_after
string
Example: updated_after=2021-11-02T14:24:55.811924Z

Returns only campaigns that have been updated after the given moment in ISO8601 format

updated_before
string
Example: updated_before=2021-11-02T14:24:55.811924Z

Returns only campaigns that have been updated before the given moment in ISO8601 format

user_id
string
Example: user_id=b1f19fe2-1493-42de-b519-4bf971ded48e

Filter the given campaigns by a user id or legacy id

after
string

Returns records after the given cursor

before
string

Returns records before the given cursor

limit
integer [ 1 .. 100 ]
Default: 10

Responses

Response samples

Content type
application/json
{
  • "data": [
    ],
  • "metadata": {
    }
}

List donation matches

Authorizations:
authorization
path Parameters
campaign_id
required
string

Campaign ID or legacy ID

query Parameters
after
string

Returns records after the given cursor

before
string

Returns records before the given cursor

limit
integer [ 1 .. 100 ]
Default: 10

Responses

Response samples

Content type
application/json
{
  • "data": [
    ],
  • "metadata": {
    }
}

Get campaign by user slug and campaign slug

Returns a Campaign by its user slug and campaign slug

Authorizations:
authorization
path Parameters
user_slug
required
string

User Slug

campaign_slug
required
string

Campaign Slug

Responses

Response samples

Content type
application/json
{
  • "data": {
    }
}

List campaign rewards by campaign ID

Authorizations:
authorization
path Parameters
campaign_id
required
string

Campaign ID or legacy ID

query Parameters
after
string

Returns records after the given cursor

before
string

Returns records before the given cursor

limit
integer [ 1 .. 100 ]
Default: 10

Responses

Response samples

Content type
application/json
{
  • "data": [
    ],
  • "metadata": {
    }
}

Get campaign by ID

Returns a campaign by its ID

Authorizations:
authorization
path Parameters
campaign_id
required
string

Campaign ID

Responses

Response samples

Content type
application/json
{
  • "data": {
    }
}

List campaign polls by campaign ID

Authorizations:
authorization
path Parameters
campaign_id
required
string

Campaign ID or legacy ID

query Parameters
after
string

Returns records after the given cursor

before
string

Returns records before the given cursor

limit
integer [ 1 .. 100 ]
Default: 10

Responses

Response samples

Content type
application/json
{
  • "data": [
    ],
  • "metadata": {
    }
}

List campaign schedules by campaign ID

Authorizations:
authorization
path Parameters
campaign_id
required
string

Campaign ID or legacy ID

query Parameters
after
string

Returns records after the given cursor

before
string

Returns records before the given cursor

limit
integer [ 1 .. 100 ]
Default: 10

Responses

Response samples

Content type
application/json
{
  • "data": [
    ],
  • "metadata": {
    }
}

List top donors by campaign ID

Authorizations:
authorization
path Parameters
campaign_id
required
string

Campaign ID

query Parameters
time_type
string
Enum: "daily" "weekly" "monthly" "yearly" "ytd" "all"
Example: time_type=all

The time range to use in leaderboard generation

after
string

Returns records after the given cursor

before
string

Returns records before the given cursor

limit
integer [ 1 .. 100 ]
Default: 10

Responses

Response samples

Content type
application/json
{
  • "data": [],
  • "metadata": {
    }
}

List campaign milestones by campaign ID

Authorizations:
authorization
path Parameters
campaign_id
required
string

Campaign ID or legacy ID

query Parameters
include_disabled
boolean
Example: include_disabled=true

Returns disabled milestones. Defaults to false

created_before
string
Example: created_before=2021-11-02T14:24:55.811924Z

Returns only milestones that have been updated before the given moment in ISO8601 format

created_after
string
Example: created_after=2021-11-02T14:24:55.811924Z

Returns only milestones that have been updated after the given moment in ISO8601 format

updated_before
string
Example: updated_before=2021-11-02T14:24:55.811924Z

Returns only milestones that have been updated before the given moment in ISO8601 format

updated_after
string
Example: updated_after=2021-11-02T14:24:55.811924Z

Returns only milestones that have been updated after the given moment in ISO8601 format

after
string

Returns records after the given cursor

before
string

Returns records before the given cursor

limit
integer [ 1 .. 100 ]
Default: 10

Responses

Response samples

Content type
application/json
{
  • "data": [
    ],
  • "metadata": {
    }
}

List campaign targets by campaign ID

Authorizations:
authorization
path Parameters
campaign_id
required
string

Campaign ID or legacy ID

query Parameters
after
string

Returns records after the given cursor

before
string

Returns records before the given cursor

limit
integer [ 1 .. 100 ]
Default: 10

Responses

Response samples

Content type
application/json
{
  • "data": [
    ],
  • "metadata": {
    }
}

List campaign donations by campaign ID

Authorizations:
authorization
path Parameters
campaign_id
required
string

Campaign ID or legacy ID

query Parameters
completed_after
string
Example: completed_after=2021-11-02T14:24:55.811924Z

Returns only donations that have been completed after the given moment in ISO8601 format

completed_before
string
Example: completed_before=2021-11-02T14:24:55.811924Z

Returns only donations that have been completed before the given moment in ISO8601 format

created_after
string
Example: created_after=2021-11-02T14:24:55.811924Z

Returns only campaigns that have been created after the given moment in ISO8601 format

created_before
string
Example: created_before=2021-11-02T14:24:55.811924Z

Returns only campaigns that have been created before the given moment in ISO8601 format

updated_after
string
Example: updated_after=2021-11-02T14:24:55.811924Z

Returns only campaigns that have been updated after the given moment in ISO8601 format

updated_before
string
Example: updated_before=2021-11-02T14:24:55.811924Z

Returns only campaigns that have been updated before the given moment in ISO8601 format

after
string

Returns records after the given cursor

before
string

Returns records before the given cursor

limit
integer [ 1 .. 100 ]
Default: 10

Responses

Response samples

Content type
application/json
{
  • "data": [
    ],
  • "metadata": {
    }
}

cause

List cause supporting events

Authorizations:
authorization
query Parameters
status
string
Enum: "published" "retired" "unpublished"
Example: status=published

Use this parameter to filter events by the given status.

supporting_type
string
Enum: "invite_only" "none" "private" "public"
Example: supporting_type=public

Use this parameter to filter events by the given supporting type.

updated_after
string
Example: updated_after=2021-11-02T14:24:55.811924Z

Returns only events that have been updated after the given moment in ISO8601 format

updated_before
string
Example: updated_before=2021-11-02T14:24:55.811924Z

Returns only events that have been updated before the given moment in ISO8601 format

after
string

Returns records after the given cursor

before
string

Returns records before the given cursor

limit
integer [ 1 .. 100 ]
Default: 10

Responses

Response samples

Content type
application/json
{
  • "data": [
    ],
  • "metadata": {
    }
}

Get the currently cause

Returns the current cause

Authorizations:
authorization

Responses

Response samples

Content type
application/json
{
  • "data": {
    }
}

donation

Get donation by ID

Returns a donation by its ID

Authorizations:
authorization
path Parameters
donation_id
required
string

Donation ID

Responses

Response samples

Content type
application/json
{
  • "data": {
    }
}

List donations

Lists the current cause donations

Authorizations:
authorization
query Parameters
created_after
string
Example: created_after=2021-11-02T14:24:55.811924Z

Returns only campaigns that have been created after the given moment in ISO8601 format

created_before
string
Example: created_before=2021-11-02T14:24:55.811924Z

Returns only campaigns that have been created before the given moment in ISO8601 format

updated_after
string
Example: updated_after=2021-11-02T14:24:55.811924Z

Returns only campaigns that have been updated after the given moment in ISO8601 format

updated_before
string
Example: updated_before=2021-11-02T14:24:55.811924Z

Returns only campaigns that have been updated before the given moment in ISO8601 format

after
string

Returns records after the given cursor

before
string

Returns records before the given cursor

limit
integer [ 1 .. 100 ]
Default: 10

Responses

Response samples

Content type
application/json
{
  • "data": [
    ],
  • "metadata": {
    }
}