APP API

APP API

The CompetitionLabs Application Programming Interface (API) is the platform on which developers build customised tools and interfaces to use with the CompetitionLabs competitions and achievements service.

Find competitions, contests, check current leader boards, achievement history and member statistics.

EXAMPLE Automatically add members and create new competitions from your existing platform or send score data to your CompetitionLabs space as events happen.

The primary domain for APP API usage is https://app.competitionlabs.com/

Generic parameters for queries

Error Codes

Achievements overview
- GET /api/:space/achievements
- GET /api/:space/achievements/:id
- GET /api/:space/achievements/:achievementId/issued
- GET /api/:space/achievements/issued/:memberId
- POST /api/:space/achievements
- PUT /api/:space/achievements/:id
- DELETE /api/:space/achievements/:id
- Sample - GET /api/:space/achievements/sample
- POST /api/:space/achievements/post
- GET /api/:space/achievements/icons
- POST /api/:space/achievements/icon-uploads

Competitions
- GET /api/:space/competitions
- GET /api/:space/competitions/:id
- GET /api/:space/competitions/:id/brackets
- GET /api/:space/competitions/simple
- POST /api/:space/competitions
- PUT /api/:space/competitions/:id/manage/Ready
- PUT /api/:space/competitions/:id/manage/Start
- PUT /api/:space/competitions/:id/manage/Cancel
- PUT /api/:space/competitions/:id/manage/Finish
- Sample - GET /api/:space/competitions/sample
- GET /api/:space/competitions/enums/list

Contests
- GET /api/:space/competitions/:competitionId/contests
- GET /api/:space/contests/:contestId/leaderboard-count
- GET /api/:space/competitions/:competitionId/contests/:contestId
- POST /api/:space/competitions/:competitionId/contests
- PUT /api/:space/competitions/:competitionId/contests/:contestId
- PUT /api/:space/competitions/:competitionId/contests/:contestId/manage/Cancel
- DELETE /api/:space/competitions/:competitionId/contests/:contestId
- Sample - GET /api/:space/competitions/:competitionId/contests/sample
- GET /api/:space/competitions/:competitionId/contests/enums/list

Rewards
- GET /api/:space/reward
- GET /api/:space/reward/:id
- GET /api/:space/reward/entity/:entityId
- POST reward
- POST /api/:space/reward/list
- PUT /api/:space/reward/:id

Awards
- GET /api/:space/awards/:id
- PUT /api/:space/awards/:id

Members overview
- GET /api/:space/members
- GET /api/:space/members/:id
- POST /api/:space/members
- PUT /api/:space/members/:id
- DELETE /api/:space/members/:id
- Sample - GET /api/:space/members/sample
- POST /api/:space/members/post
- GET /api/:space/members/memberRef/:memberRefId
- GET /api/:space/members/enums/list

Products overview
- GET /api/:space/products
- GET /api/:space/products/:id
- POST /api/:space/products
- PUT /api/:space/products/:id
- DELETE /api/:space/products/:id
- Sample - GET /api/:space/products/sample

Events
- GET /api/:space/events
- GET /api/:space/events/:id
- POST /api/:space/events
- POST /api/:space/events/upload
- Sample - GET /api/:space/events/sample

Member-messages
- GET /api/:space/member-messages
- GET /api/:space/member-messages/:id
- GET /api/:space/member-messages/memberRef/:memberRefId
- GET /api/:space/member-messages/memberRef/:memberRefId/:messageId

Translations
- GET /api/:space/translations
- GET /api/:space/translations/languages
- POST /api/:space/translations
- DELETE /api/:space/translations/:id

Unit Of Measure
- GET /api/:space/unitofmeasure
- GET /api/:space/unitofmeasure/:id
- POST /api/:space/unitofmeasure
- PUT /api/:space/unitofmeasure
- DELETE /api/:space/unitofmeasure/:id
- GET /api/:space/unitofmeasure/types

Reward Type
- GET /api/:space/account/reward-types
- GET /api/:space/account/reward-types/:id
- POST /api/:space/account/reward-types
- PUT /api/:space/account/reward-types/:id
- DELETE /api/:space/account/reward-types/:id

Action Helper
- GET /api/:space/account/rule-action-helper
- GET /api/:space/account/rule-action-helper/:id
- POST /api/:space/account/rule-action-helper
- PUT /api/:space/account/rule-action-helper/:id
- DELETE /api/:space/account/rule-action-helper/:id

Domain
- AccountMessage
- Achievement
- AchievementLink
- ActionAdjustmentFactor
- Attachment
- Award model
- Competition
- ComplexFilters
- Contest
- CustomField
- Event
- EventMetadata
- LanguageHelper
- MainConditionSet
- MainRule
- MaxMin
- Member
- MemberMessage
- MemberNotification
- Metadata
- Notification
- Options
- Product
- RankingStrategy
- Reward model
- RewardType
- RuleActionHelper
- RuleSet
- Scheduling
- ScoringStrategy
- StartEndDate
- Strategies
- SubConditionSet
- SubRule
- Translation
- UnitOfMeasure

Rules
- Contest rules
- Achievement rules
- Competition "rules" parameters