Need help with your APIs? I offer API discovery, governance & evangelism services. Explore services →
API Evangelist API Evangelist
Discovery
Learnings
Guidance
Toolbox
Alignment
API Evangelist LLC

WeFitter team API

The team API from WeFitter — 5 operation(s) for team.

WeFitter team API is one of 9 APIs that WeFitter publishes on the APIs.io network, described by a machine-readable OpenAPI specification.

Tagged areas include team. The published artifact set on APIs.io includes an OpenAPI specification and an API reference.

This API exposes 12 operations across 5 paths, and defines 5 schemas. It is described by OpenAPI 2.0, at version v1.3.

Requests are made against the base URL https://api.wefitter.com/api/v1.3.

12 operations 5 paths 5 schemas 2 DELETE2 GET1 PATCH4 POST3 PUT

Metadata

The identity and technical contract details declared by the specification.

Specification
OpenAPI 2.0
API Version
v1.3
Base URL
https://api.wefitter.com/api/v1.3
Authentication
basic, API Key, API Key
License
BSD License
Terms of Service
Resource Areas
1

Authentication & Security 3

WeFitter team API declares 3 security schemes for authenticating requests. It defines a basic scheme (Basic). An API key is passed in the header as Authorization (BearerProfile). An API key is passed in the header as Authorization (BearerAdmin). By default, every request must be authenticated.

  • Basic — Basic Authentication is used to create administrator bearer tokens. Once a bearer token has been made, remove this auth. ('logout' in Swagger')
  • BearerProfile — Bearer authentication for logged-in profiles. When using the GUI, please don't forget to prefix your bearer tokens with the text 'bearer', followed by a space.
  • BearerAdmin — Bearer authentication for administrators. When using the GUI, please don't forget to prefix your bearer tokens with the text 'bearer', followed by a space.

Paths & Operations 12

Across 5 paths, the API surfaces 12 operations — 2 DELETE, 2 GET, 1 PATCH, 4 POST, 3 PUT. Each is listed below with its method, path, parameters, and response codes.

team 12
GET
/team/
List Teams
team_list 2 params → 200
POST
/team/
Create Team
team_create 1 param → 201
GET
/team/{public_id}/
Team
team_read 1 param → 200
PUT
/team/{public_id}/
Edit Team
team_update 2 params → 200
PATCH
/team/{public_id}/
Partial Edit a Team
team_partial_update 2 params → 200
DELETE
/team/{public_id}/
Deletes a Team
team_delete 1 param → 204
POST
/team/{public_id}/member/
Add member
team_member_create 2 params → 201
PUT
/team/{public_id}/member/
Add member
team_member_update 2 params → 200
DELETE
/team/{public_id}/member/
Remove member
team_member_delete 2 params → 204
POST
/team/{public_id}/members/
Add members
team_members_create 2 params → 201
PUT
/team/{public_id}/members/
Add members
team_members_update 2 params → 200
POST
/team/{public_id}/remove_members/
Remove members
team_remove_members 2 params → 201

Schemas 5

The contract defines 5 schemas that model the data the API accepts and returns. The most detailed are TeamDetail (7 properties), TeamList (5 properties), ProfileTeam (4 properties), ProfilePublicIdsList (3 properties). Each schema is shown below with its type and property counts.

TeamList
object
5 properties 1 required
ProfilePublicIdsList
object
3 properties 1 required
TeamDetail
object
7 properties 2 required
ProfileTeam
object
List of members in this team
4 properties
ProfileAsProfilePublicId
object
2 properties 1 required

Specification

The full machine-readable OpenAPI contract behind this narrative.

Source

wefitter-team-api-openapi.yml Raw ↑

Other APIs WeFitter publishes across the network.

WeFitter app API
WeFitter challenge API
WeFitter connection API
WeFitter insights API
WeFitter loyalty API
WeFitter notification API
WeFitter profile API
WeFitter token API