Skip to main content

V5ApiPublic (1.0)

Download OpenAPI specification:Download

Welcome to the Tiltify V5 API docmentation site.

This is the public API for Tiltify. It is intended to be used by third party developers to build integrations with Tiltify. Additional documentation may be found at the Tiltify Developers documentation site.

OpenAPI Specification

The API uses the OpenAPI Specification (OAS) to define the API. More information about the OpenAPI Specification can be found at https://swagger.io/specification/.

Authentication

Tiltify uses OAuth 2.0 access tokens to authenticate API requests. You may get an Application access_token or a User access_token. To authenticate, you will need to create an application in the Tiltify User Dashboard, and use the generated credentials.

Getting an Application Access Token

The method to get an application access token follows the Client Credentials Oauth2 grant flow.

You may give the required parameters to the Oauth Token Endpoint to get an access token for use with the api directly.

Getting a User Access Token

The method to get a user access token follows the OAuth2 Authorization Grant flow. The following is a specific example of how to retrieve A User Access token using OAuth2

Getting the code

This example will be using the following values as needed.

To begin with, send a user in a browser to the Tiltify OAuth Authorization url. Include your Client ID, and the response type of code as query parameters. You may include your redirect URI if you have more than one. A space separated list of scopes may also be added, however, if not included, the public scope will be automatically selected.

https://v5api.tiltify.com/oauth/authorize?&client_id=1234&response_type=code&redirect_uri=https%3A%2F%2Fwww.example.com%2Fredirect&scope=public

After signing in and authorizing, the user will be redirected back to your chosen redirect URI with a query parameter of code, containing the code used to fetch the access token.

https://www.example.com/redirect?code=1234abcdef

The code should be passed to your server backend as the following steps require your secret key, which should not be exposed to the public.

Converting The Code To A User Access Token

To retrieve the User Access Token, a post request must be made to the Token URL. In the body of the url are the following fields in Form Data format. Note specifically that code is the code retrieved from the first step.

client_id=1234
redirect_uri=https://www.example.com/redirect
code=1234abcdef
grant_type=authorization_code

Tiltify will return a response like the following:

{

    "access_token": "ab6a592346444dea97170837e104d8a5ab6a592346444dea97170837e104d8a5",
    "created_at": "2023-01-27T19:32:03Z",
    "expires_in": 7200,
    "refresh_token": "njjjytm3otetmgrjmi00yjawlwe4zgytzjixy2mzm2y3njawcg121231999393a3",
    "scope": "public",
    "token_type": "bearer"

}

This access token may now be used as shown below to make requests. When used with the /current-user endpoint, the full user object is returned.

Using Access Tokens

Add the Authorization header to your HTTP request.

Authorization: Bearer <access_token>

Example:

Authorization: Bearer ab6a592346444dea97170837e104d8a5ab6a592346444dea97170837e104d8a5

Using Refresh Tokens

When an initial access token is created, a refresh token will be provided. The refresh token can be used to get a new access token when the current one expires. To do this, make a post request to the token url with grant_type set to refresh_token.

Example:

To refresh the User Access Token, a post request must be made to the Token URL. In the body of the url are the following fields in Form Data or json format.

client_id=1234
client_secret=asdf
grant_type=refresh_token
refresh_token=njjjytm3otetmgrjmi00yjawlwe4zgytzjixy2mzm2y3njawcg121231999393a3

authorization

Security Scheme Type: HTTP
HTTP Authorization Scheme: bearer

Webhooks

Tiltify provides a dashboard to subscribe and test campaign and campaign donation webhooks.

To register a webhook, visit the Developer Dashboard

Registering a webhook

In order to begin registering webhooks, you must first create an application.

In the application dashboard, there will be a side navigation option for Webhooks.

  • Click the Add Webhook button
  • Create the webhook with an endpoint URL and an optional description.
  • Click edit on the newly created webhook
  • Click the Events submenu and add and event to subscribe to using the Add event button.
  • Enter your Campaign ID, this can be found in your campaign's dashboard under Setup > Information
  • Once created, click the ... button and select Edit
  • Select the donation and/or Campaign events you would like to receive to your webhook endpoint and click Update Event. Including private data may include sensitive information, so please ensure that you secure your application.

You should now receive updates for those events on your webhook url.

Caution: When we send a webhook we expect the endpoint to respond with a 200-299 status code. If we do not receive that, we deactivate the webhook after about an hour.

Testing

Once a webhook is created, you may send test messages through the Testing Submenu.

An example payload will be shown for each event type.

Click Send Test to initiate the test.

Auction House

Auction House endpoints

Get auction house by user slug and auction house slug

Returns an auction house by its user slug and auction house slug

Authorizations:
authorization
path Parameters
user_slug
required
string

User slug

auction_house_slug
required
string

Auction house slug

Responses

Response samples

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

Get by ID

Returns a auction house by its ID

Authorizations:
authorization
path Parameters
auction_house_id
required
string

Auction House ID

Responses

Response samples

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

List auction items

Authorizations:
authorization
path Parameters
auction_house_id
required
string

Auction House ID

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

Returns only auction items 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 auction items 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 auction items 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 auction items that have been updated after the given moment in ISO8601 format

status
string
Example: status=completed

Status of the auction item. One of: active, or completed

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 auction house auction item by ID

Returns a auction item by its ID

Authorizations:
authorization
path Parameters
auction_house_id
required
string

Auction House ID

auction_item_id
required
string

Auction Item ID

Responses

Response samples

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

List auction bids for an auction item

Authorizations:
authorization
path Parameters
auction_house_id
required
string

Auction House ID

auction_item_id
required
string

Auction Item 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 auction house by cause slug and auction house slug

Returns an auction house by its cause slug and auction house slug

Authorizations:
authorization
path Parameters
cause_slug
required
string

Caus slug

auction_house_slug
required
string

Auction house slug

Responses

Response samples

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

Campaign

Campaign endpoints

List schedules

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 fitness goals

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 polls

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 targets

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 poll by ID

Returns a poll by its ID

Authorizations:
authorization
path Parameters
poll_id
required
string

Poll ID

campaign_id
required
string

Campaign ID

Responses

Response samples

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

List donations

Authorizations:
authorization
path Parameters
campaign_id
required
string

Campaign ID or legacy ID

query Parameters
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

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

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
created_before
string
Example: created_before=2021-11-02T14:24:55.811924Z

Returns only donation matches 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 donation matches 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 donation matches 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 donation matches that have been updated after the given moment in ISO8601 format

status
string
Example: status=completed

Status of the donation match. One of: active, or completed

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 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 rewards

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 milestones

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 top donors

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

Cause

Cause endpoints

List top teams

Authorizations:
authorization
path Parameters
cause_id
required
string

Cause 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 fundraising events

Authorizations:
authorization
path Parameters
cause_id
required
string

Cause 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

Authorizations:
authorization
path Parameters
cause_id
required
string

Cause 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 configured leaderboards Deprecated

Authorizations:
authorization
path Parameters
cause_id
required
string

cause id

Responses

Response samples

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

List top fundraisers

Authorizations:
authorization
path Parameters
cause_id
required
string

Cause 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": {
    }
}

Get by ID

Returns a cause by its ID

Authorizations:
authorization
path Parameters
cause_id
required
string

Cause ID

Responses

Response samples

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

Fundraising Event

Fundraising Event endpoints

List configured leaderboards Deprecated

Authorizations:
authorization
path Parameters
fundraising_event_id
required
string

fundraising event id

Responses

Response samples

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

List top teams

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 fundraisers

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

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 distances

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

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 donors

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 campaigns

Returns supporting campaigns by Fundraising Event ID

Authorizations:
authorization
path Parameters
fundraising_event_id
required
string

Fundraising event 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 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 teams fitness distances

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 fitness goals

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 donations Deprecated

This endpoint will list donations for a given Fundraising Event. Contact support for access to this endpoint.

Authorizations:
authorization
path Parameters
fundraising_event_id
required
string

FundraisingEvent ID or legacy ID

query Parameters
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

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

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

OAuth 2.0 endpoints

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: "public"
Value: "public"

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": "public",
  • "token_type": "bearer"
}

Authorize

Returns a code through the applications redirect_uri to be used with the /token with the authorization_code grant.

Authorizations:
authorization
query Parameters
client_id
required
string

Client Id

redirect_uri
required
string

Redirect URI

response_type
required
string
Value: "code"

Response Type

scope
string
Default: "public"
Value: "public"

Scope

Personal Campaign

Personal Campaign endpoints

List milestones

Authorizations:
authorization
path Parameters
personal_campaign_id
required
string

Campaign 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 rewards

Authorizations:
authorization
path Parameters
personal_campaign_id
required
string

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

Get campaign poll by ID

Returns a poll by its ID

Authorizations:
authorization
path Parameters
poll_id
required
string

Poll ID

personal_campaign_id
required
string

Campaign ID

Responses

Response samples

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

Get by ID

Returns a personal campaign by its ID

Authorizations:
authorization
path Parameters
personal_campaign_id
required
string

Personal Campaign ID

Responses

Response samples

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

List gifts

Authorizations:
authorization
path Parameters
personal_campaign_id
required
string

Campaign ID

query Parameters
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

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

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 schedules

Authorizations:
authorization
path Parameters
personal_campaign_id
required
string

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 polls

Authorizations:
authorization
path Parameters
personal_campaign_id
required
string

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 targets

Authorizations:
authorization
path Parameters
personal_campaign_id
required
string

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

Team

Team endpoints

Get by ID

Returns a team by its ID

Authorizations:
authorization
path Parameters
team_id
required
string

Team ID

Responses

Response samples

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

List team members

Authorizations:
authorization
path Parameters
team_id
required
string

Team 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 Campaigns

Authorizations:
authorization
path Parameters
team_id
required
string

Team ID

query Parameters
status
string
Enum: "published" "retired"
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

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 by slug

Returns a team by its slug

Authorizations:
authorization
path Parameters
slug
required
string

Team slug

Responses

Response samples

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

Team Campaign

Team Campaign endpoints

List targets

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 polls

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 donations

Authorizations:
authorization
path Parameters
team_campaign_id
required
string

Team Campaign ID or legacy ID

query Parameters
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

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

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 schedules

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

List top fundraisers

Authorizations:
authorization
path Parameters
team_campaign_id
required
string

Team Event 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 fitness goals

Authorizations:
authorization
path Parameters
team_campaign_id
required
string

TeamCampaign 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 poll by ID

Returns a poll by its ID

Authorizations:
authorization
path Parameters
poll_id
required
string

Poll ID

team_campaign_id
required
string

Team Campaign ID or legacy ID

Responses

Response samples

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