profile

Challenge

Provides a list of challenges where the profile can participate and is already participating in.

This endpoint returns a list of objects.

get/profile/{public_id}/challenge/

Request

Base URL
https://api.wefitter.com/api/v1
Auth
API key in header Authorization
TypeScript
https://skmtc.dev/wefitter/apis/wefitter-api/docs/profile/:public_id/challenge/get.ts
A function with typed inputs. Its response is checked against the schema.

recentinteger

Show challenges that have not ended in the last N weeks

date_startstring date-time

Only return challenges that are active after this time

Note: this only affects challenges that are not joined.

Defaults to now

date_endstring date-time

Only return challenges that are active before this time

Note: this only affects challenges that are not joined.

Defaults to now

urlstring uri

public_idstring uuid

titlestring required

sloganstring

descriptionstring

startstring date-time required

endstring date-time nullable

type'INDIVIDUAL' | 'GROUP' | 'TEAM' required

goal'DAILY' | 'TOTAL' | 'WEEKLY' | 'MONTHLY' required

goal_valueinteger nullable

goal_type'POINTS' | 'DISTANCE' | 'CALORIES' | 'DURATION' | 'STEPS' required

visibility'PUBLIC' | 'PRIVATE' required

num_membersstring

leaderboard_rankinteger

Current or final rank among the participants of the challenge as determined by the relevant score.

leaderboard_scorenumber

The profile's current or final score.

is_participatingboolean

Does the current profile participate in this challenge?

No recorded changes to this operation across all 1 revision of this API.