Public
Documentation Settings

Teamwork API Documentation

Endpoints implemented

METHODEndpointDescriptionRequest header(s)
POST/api/v2/signupRegister an accountContent-Type: application/json
POST/api/v2/signinSign inContent-Type: application/json
POST/api/v2/article/createCreate a new articleContent-Type: application/json, Authorization: Bearerspacetoken
PATCH/api/v2/article/update/:idModify a specific articleContent-Type: application/json, Authorization: Bearerspacetoken
DELETE/api/v1/article/delete/:idDelete a specific articleContent-Type: application/json, Authorization: Bearerspacetoken
GET/api/v2/article/:idGet a specific articleContent-Type: application/json, Authorization: Bearerspacetoken
GET/api/v2/feedsGet all articlesContent-Type: application/json, Authorization: Bearerspacetoken
POST/api/v2/article/:id/commentsComment on a specific articleContent-Type: application/json, Authorization: Bearerspacetoken

POSTSignUp

https://teamwork-ac11.herokuapp.com/api/v2/signup
HEADERS
Content-Type

application/json

Bodyraw
  {
    "firstName": "Paul",
    "lastName": "Sebalu",
    "email": "manzi@teamwork.com",
    "password": "Canwedothis1moretime"
  }
Example Request
curl
curl --location 'https://teamwork-ac11.herokuapp.com/api/v2/signup' \
--header 'Content-Type: application/json' \
--data-raw '  {
    "firstName": "Paul",
    "lastName": "Sebalu",
    "email": "manzi@teamwork.com",
    "password": "Canwedothis1moretime"
  }'
Example Response
No response body
This request doesn't return any response body
No response headers
This request doesn't return any response headers

POSTLogIn

https://teamwork-ac11.herokuapp.com/api/v2/signin
HEADERS
Content-Type

application/json

Bodyraw
{
    "email": "manzi@teamwork.com",
    "password": "Canwedothis1moretime"
}
Example Request
curl
curl --location 'https://teamwork-ac11.herokuapp.com/api/v2/signin' \
--header 'Content-Type: application/json' \
--data-raw '{
    "email": "manzi@teamwork.com",
    "password": "Canwedothis1moretime"
}'
Example Response
No response body
This request doesn't return any response body
No response headers
This request doesn't return any response headers

POSTCreateArticle

https://teamwork-ac11.herokuapp.com/api/v2/article/create
HEADERS
Authorization

Bearer eyJhbGciOiJIUzI1NiIsInR5cCI6IkpXVCJ9.eyJlbXBsb3llZUlkIjoxNiwiaWF0IjoxNTcwNzgxNDcxfQ.sRggyAK6Z5VUHSYVdvzjBE1J1-Oye7IsPNlLAUWj8L0

Content-Type

application/json

Bodyraw
{
	"title": "Article title",
	"article": "Article body",
	"category": "bootcamp"
}
Example Request
curl
curl --location 'https://teamwork-ac11.herokuapp.com/api/v2/article/create' \
--header 'Authorization: Bearer eyJhbGciOiJIUzI1NiIsInR5cCI6IkpXVCJ9.eyJlbXBsb3llZUlkIjoxNiwiaWF0IjoxNTcwNzgxNDcxfQ.sRggyAK6Z5VUHSYVdvzjBE1J1-Oye7IsPNlLAUWj8L0' \
--header 'Content-Type: application/json' \
--data '{
	"title": "Article title",
	"article": "Article body",
	"category": "bootcamp"
}'
Example Response
No response body
This request doesn't return any response body
No response headers
This request doesn't return any response headers