Download OpenAPI specification:Download
This specification documents the available endpoints and possible operations on the website's backend. For each of the operations, its purpose, security, requests and possible responses are documented.
Postman collection also available here.
This endpoint operation allows to check if a given access token is valid, returning the associated account's information.
Authorization required | string Example: Bearer eyJhbGciOiJSUzI1NiJ9.eyJpc3MiOiJzZWxmIiwic3ViIjoidGVzdF9hY2NvdW50QHRlc3QuY29tIiwiZXhwIjoxNjg4MjYyMzYxLCJpYXQiOjE2ODgyNTg3NjEsInNjb3BlIjoiQk9BUkQgTUVNQkVSIn0.gS6KIJNZhZZXRMaaH8j8VuSf7okZ0ZqkoxOj_CjJBhHGjFlH6pAhN8743YH5KV0VzCefxJhplvf_2sCzk2dKzdPNvlBNe7v15dFmAmfBl5ygjXAjIjvQ079GwCkKxR05-V_rJ1BJ2clKL1f7Uwak5DE7xUCPJ5ZtogJE7jHeIqc49J0i39--6rAjvvrTd0NIW9OXEDjMxN81pzs-YwS2iyNSNN52rOsTOzY3xgf17RVDbZJXOSDH-0ZP2Quu4izwfDQXwZ2YpwuQ2M8FaJtxljJQgzotN0tta_EAjrzjMT7-ukXUsFHpudXu-TCOk1VF1hzQbpBlu2Xia20Cpy6qXg Bearer authentication token |
{- "authenticated_user": {
- "name": "Test Account",
- "email": "test_account@test.com",
- "bio": "This is a test account",
- "birthDate": "28-07-2001",
- "websites": [
], - "id": 1
}
}
This endpoint operation allows authentication using user's password and email, generating new access and refresh tokens to be used in following requests.
password | string Password of the account |
string Email of the account |
{- "email": "president@niaefeup.pt",
- "password": "testPassword"
}
{- "access_token": "eyJhbGciOiJSUzI1NiJ9.eyJpc3MiOiJzZWxmIiwic3ViIjoidGVzdF9hY2NvdW50QHRlc3QuY29tIiwiZXhwIjoxNjg4MjYyMzYyLCJpYXQiOjE2ODgyNTg3NjIsInNjb3BlIjoiQk9BUkQgTUVNQkVSIn0.shviy7EStn24QSHzPgjTTmnvF_kj_gqJ8PRv-_2ODggkr0L4vjNdTgWOGvXNLIvmifmZVTlcWcgagxmDmXObeKbDp7yOw87B_AP1ntFBffHdBrFpFdJfKFDcu5HgFlbo34OkBjgPIAG7YQN0aVR3V161blc1cdQSeWUk3gd_skX8NvQupBYidsn7Zt_yTF1r2nvyQf3duAkJN4gmtnOD5tP8fEmkgL_6rQ-cMPl3D1zKZVhhB5VYKWOzSMET-jpQVdEbiEnRjiGMZ7FiRfmt2ARG2TDFE4gwWYFmdoLTYIHYtmM7POV3Fiv9loANSG3NHTM3sZSVowl79ggmTfoK9w",
- "refresh_token": "eyJhbGciOiJSUzI1NiJ9.eyJpc3MiOiJzZWxmIiwic3ViIjoidGVzdF9hY2NvdW50QHRlc3QuY29tIiwiZXhwIjoxNjg4ODYzNTYyLCJpYXQiOjE2ODgyNTg3NjIsInNjb3BlIjoiIn0.zPkj0wMbeZc7Gutk5dt2VXAKuhCZC2rl6uoEZN4BFwbfhA5CI4mXTAe7YP2Xm4oJ0iQ2Rg69q_9OMr3D_T-5hMYbxYdrkR5MxyNeOimq-wYPgYVEWWsS98zUsxjbjhypyv3W3KEEvRcCLd5OLVBH6nDQ4CljaKRZi5Ppw-WMUfnoY61ieaLkLwpT4rtea0rULgMLTCILuiROWwy0JtkZZPZ-jLFtI3WjXTkBF5SWF0rdshp_82stXRjG6AYCPVjdnaNpLEOtLAxAvZ-tJridqQIen4h8iJaPSB3BvTEG3JuMkCW6sYltHqDSevvnyyR9zYnk6yfnGlF_Jl9jHOpnqg"
}
This endpoint operation allows the renewal of the access token, using the currently valid refresh token.
token | string Refresh token, used to refresh the access token |
{- "token": "eyJhbGciOiJSUzI1NiJ9.eyJpc3MiOiJzZWxmIiwic3ViIjoidGVzdF9hY2NvdW50QHRlc3QuY29tIiwiZXhwIjoxNjg4ODYzNTYzLCJpYXQiOjE2ODgyNTg3NjMsInNjb3BlIjoiIn0.ExYN05daOWn_CNKi_n7pmuJshC6P_zH5-WLpmWEBqxxUVLzzr1bdlk_NrmRnoCVnfTdlO0JmIgSTIuxpeQ4qHDDAy7nXY3OrHCs40TShGLzRjoWR6sXJwUPPZR8P745HE135Lkj16iwgAmk2ufPaRBQN394DJ4aDjgmUY52UQm8ADKg24EAYZKniQyO-dDpnAndyutcueffonBMi4mA3u_K8cm-wefzbEKW5_PsEMWaNTuVG6Ho6cTpk-EtlDUPaIdKn8Fi921BqPuoXdjT4xegmjG6usQFHDfoDq-ZSIAkjxUcDO1Ds_ha_B7WTjpjFVgOPuDSWe019R97CwBbOAg"
}
{- "access_token": "eyJhbGciOiJSUzI1NiJ9.eyJpc3MiOiJzZWxmIiwic3ViIjoidGVzdF9hY2NvdW50QHRlc3QuY29tIiwiZXhwIjoxNjg4MjYyMzYzLCJpYXQiOjE2ODgyNTg3NjMsInNjb3BlIjoiQk9BUkQgTUVNQkVSIn0.ftQd4eKxo1SRNZ3VRuDo3vrJoMLBLOih1bfmYWehUAhQdvPeFjY5V1NRfNXuJG5DhzMnO13pDoJZYefc8N7t2h1Cu8hHoj96Jj1m15U5msBHdTh1RhRZbzjjRhhXKSk-LYKXQ7ik5G3VcXK-WsidznvCb52XsDzN38SQGMbbfQKHTRzAzZdfhIVY7FRLwJCBxdZtTfZAI2_beDTg6iKcEsSHVVWiLMu6O3vKc0tKR1H6nuIlTq82s0HlTRlPSIGSNyjI7YWX7EUSP3TEPSZgekQ6Azp94I6v_-se2lpD4u2cs1DKciYRdnTcYXHkcNenUH7jdYklV47c7QzZV1PQQw"
}
The operation returns an array of accounts, allowing to easily retrieve all the created accounts.
[- {
- "name": "Test Account",
- "email": "test_account@test.com",
- "bio": "This is a test account",
- "birthDate": "28-07-2001",
- "websites": [
], - "id": 1
}, - {
- "name": "Test Account 2",
- "email": "test_account2@test.com",
- "websites": [ ],
- "id": 2
}
]
This endpoint allows the retrieval of a single account using its ID.
id required | string ID of the account to retrieve |
{- "name": "Test Account",
- "email": "test_account@test.com",
- "bio": "This is a test account",
- "birthDate": "28-07-2001",
- "websites": [
], - "id": 1
}
Replaces sets a new account password
id required | string ID of the account to change the password. |
oldPassword | string Current account password |
newPassword | string New account password |
{- "oldPassword": "wrong_password",
- "newPassword": "test_password2"
}
{ }
The operation returns an array of events, allowing to easily retrieve all the created events. This is useful for example in the frontend's event page, where events are displayed.
[- {
- "title": "Great event",
- "description": "This was a nice and iconic event",
- "teamMembers": [
- {
- "name": "Test Account",
- "email": "test_account@test.com",
- "bio": "This is a test account",
- "birthDate": "28-07-2001",
- "websites": [
], - "id": 1
}
], - "slug": "great-event",
- "dateInterval": {
- "startDate": "28-07-2022",
- "endDate": "30-07-2022"
}, - "location": "FEUP",
- "category": "Great Events",
- "id": 1
}, - {
- "title": "Bad event",
- "description": "This event was a failure",
- "teamMembers": [ ],
- "dateInterval": {
- "startDate": "27-10-2021"
}, - "id": 2
}
]
This endpoint operation creates a new event.
Array of objects Team member IDs | |
registerUrl | string Link to the event registration |
thumbnailPath | string Thumbnail of the event |
description | string Event description |
location | string Location for the event |
category | string Event category |
title | string Event title |
object Date interval of the event | |
slug | string Short and friendly textual event identifier |
{- "title": "Great event",
- "description": "This was a nice and iconic event",
- "dateInterval": {
- "startDate": "28-07-2022",
- "endDate": "30-07-2022"
}, - "thumbnailPath": "",
- "slug": "great-event"
}
{- "title": "Great event",
- "description": "This was a nice and iconic event",
- "teamMembers": [
- {
- "name": "Test Account",
- "email": "test_account@test.com",
- "bio": "This is a test account",
- "birthDate": "28-07-2001",
- "websites": [
], - "id": 1
}
], - "slug": "great-event",
- "dateInterval": {
- "startDate": "28-07-2022",
- "endDate": "30-07-2022"
}, - "location": "FEUP",
- "category": "Great Events",
- "id": 1
}
This endpoint allows the retrieval of a single event using its ID. It might be used to generate the specific event page.
id required | string ID of the event to retrieve |
{- "title": "Great event",
- "description": "This was a nice and iconic event",
- "teamMembers": [
- {
- "name": "Test Account",
- "email": "test_account@test.com",
- "bio": "This is a test account",
- "birthDate": "28-07-2001",
- "websites": [
], - "id": 1
}
], - "slug": "great-event",
- "dateInterval": {
- "startDate": "28-07-2022",
- "endDate": "30-07-2022"
}, - "location": "FEUP",
- "category": "Great Events",
- "id": 1
}
Update a previously created event, using its ID.
id required | string ID of the event to update |
Array of objects Team member IDs | |
registerUrl | string Link to the event registration |
thumbnailPath | string Thumbnail of the event |
description | string Event description |
location | string Location for the event |
category | string Event category |
title | string Event title |
object Date interval of the event | |
slug | string Short and friendly textual event identifier |
{- "title": "Great event",
- "description": "This was a nice and iconic event",
- "dateInterval": {
- "startDate": "28-07-2022",
- "endDate": "30-07-2022"
}, - "location": "aaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa"
}
{- "title": "New event title",
- "description": "New event description",
- "teamMembers": [ ],
- "slug": "new-slug",
- "dateInterval": {
- "startDate": "01-12-2022",
- "endDate": "02-12-2022"
}, - "location": "FLUP",
- "category": "Greatest Events",
- "id": 1
}
This endpoint allows the retrieval of a single event using its slug.
slug required | string Short and friendly textual event identifier |
{- "title": "Great event",
- "description": "This was a nice and iconic event",
- "teamMembers": [
- {
- "name": "Test Account",
- "email": "test_account@test.com",
- "bio": "This is a test account",
- "birthDate": "28-07-2001",
- "websites": [
], - "id": 1
}
], - "slug": "great-event",
- "dateInterval": {
- "startDate": "28-07-2022",
- "endDate": "30-07-2022"
}, - "location": "FEUP",
- "category": "Great Events",
- "id": 1
}
This endpoint allows the retrieval of events labeled with a given category. It might be used to filter events in the event page.
category required | string Category of the events to retrieve |
[- {
- "title": "Great event",
- "description": "This was a nice and iconic event",
- "teamMembers": [ ],
- "slug": "great-event",
- "dateInterval": {
- "startDate": "28-07-2022",
- "endDate": "30-07-2022"
}, - "location": "FEUP",
- "category": "Great Events",
- "id": 1
}, - {
- "title": "Cool event",
- "description": "This event was a awesome",
- "teamMembers": [
- {
- "name": "Test Account",
- "email": "test_account@test.com",
- "bio": "This is a test account",
- "birthDate": "28-07-2001",
- "websites": [
], - "id": 1
}
], - "dateInterval": {
- "startDate": "11-09-2022"
}, - "category": "Great Events",
- "id": 4
}
]
This operation adds a team member to a given event.
eventId required | string ID of the event to add the member to |
accountId required | string ID of the account to add |
{- "title": "Great event",
- "description": "This was a nice and iconic event",
- "teamMembers": [
- {
- "name": "Test Account",
- "email": "test_account@test.com",
- "bio": "This is a test account",
- "birthDate": "28-07-2001",
- "websites": [
], - "id": 1
}, - {
- "name": "Another test Account",
- "email": "test2_account@test.com",
- "bio": "This is another test account",
- "birthDate": "04-04-2003",
- "websites": [
], - "id": 2
}
], - "slug": "great-event",
- "dateInterval": {
- "startDate": "28-07-2022",
- "endDate": "30-07-2022"
}, - "location": "FEUP",
- "category": "Great Events",
- "id": 1
}
This operation removes a team member of a given event.
eventId required | string ID of the event to remove the member from |
accountId required | string ID of the account to remove |
{- "title": "Great event",
- "description": "This was a nice and iconic event",
- "teamMembers": [ ],
- "slug": "great-event",
- "dateInterval": {
- "startDate": "28-07-2022",
- "endDate": "30-07-2022"
}, - "location": "FEUP",
- "category": "Great Events",
- "id": 1
}
[- {
- "section": "section-role1",
- "accounts": [
- {
- "name": "Test Account",
- "email": "test-account@gmail.com",
- "websites": [ ],
- "id": 1,
- "roles": [
- "regular-role1",
- "regular-role2"
]
}
]
}, - {
- "section": "section-role2",
- "accounts": [
- {
- "name": "Test Account 2",
- "email": "test-account2@gmail.com",
- "websites": [ ],
- "id": 2,
- "roles": [
- "regular-role2"
]
}
]
}
]
This operation creates a new generation.
Array of objects Roles associated with the generation | |
schoolYear | string School year of the generation |
{- "schoolYear": "20-21",
- "roles": [
- {
- "name": "role1",
- "permissions": [ ],
- "isSection": true,
- "accountIds": [ ],
- "associatedActivities": [ ]
}, - {
- "name": "role2",
- "permissions": [ ],
- "isSection": false,
- "accountIds": [ ],
- "associatedActivities": [ ]
}
]
}
{- "schoolYear": "20-21",
- "id": 1,
- "roles": [
- {
- "name": "role1",
- "permissions": [ ],
- "isSection": true,
- "id": 1,
- "associatedActivities": [ ]
}, - {
- "name": "role2",
- "permissions": [ ],
- "isSection": false,
- "id": 2,
- "associatedActivities": [ ]
}
]
}
This operation retrieves the generation using its id.
id required | string Id of a generation |
[- {
- "section": "section-role1",
- "accounts": [
- {
- "name": "Test Account",
- "email": "test-account@gmail.com",
- "websites": [ ],
- "id": 1,
- "roles": [
- "regular-role1",
- "regular-role2"
]
}
]
}, - {
- "section": "section-role2",
- "accounts": [
- {
- "name": "Test Account 2",
- "email": "test-account2@gmail.com",
- "websites": [ ],
- "id": 2,
- "roles": [
- "regular-role2"
]
}
]
}
]
Update a generation school year, using its Id as a parameter
id required | string Id of a generation |
schoolYear | string New school year |
{- "schoolYear": "19-20"
}
{- "schoolYear": "19-20",
- "id": 1,
- "roles": [
- {
- "name": "section-role1",
- "permissions": [ ],
- "isSection": true,
- "id": 1,
- "associatedActivities": [
- {
- "permissions": [ ],
- "id": 1,
- "activity": {
- "title": "NIJobs",
- "description": "cool project",
- "teamMembers": [ ],
- "isArchived": false,
- "technologies": [ ],
- "id": 1
}
}
]
}, - {
- "name": "section-role2",
- "permissions": [ ],
- "isSection": true,
- "id": 2,
- "associatedActivities": [ ]
}, - {
- "name": "regular-role1",
- "permissions": [ ],
- "isSection": false,
- "id": 3,
- "associatedActivities": [
- {
- "permissions": [ ],
- "id": 2,
- "activity": {
- "title": "SINF",
- "description": "cool event",
- "teamMembers": [ ],
- "dateInterval": {
- "startDate": "10-10-2023"
}, - "id": 2
}
}
]
}, - {
- "name": "regular-role2",
- "permissions": [ ],
- "isSection": false,
- "id": 4,
- "associatedActivities": [ ]
}
]
}
This operation retrieves the generation associated with a given school year.
schoolYear required | string School year associated with a generation |
[- {
- "section": "section-role1",
- "accounts": [
- {
- "name": "Test Account",
- "email": "test-account@gmail.com",
- "websites": [ ],
- "id": 1,
- "roles": [
- "regular-role1",
- "regular-role2"
]
}
]
}, - {
- "section": "section-role2",
- "accounts": [
- {
- "name": "Test Account 2",
- "email": "test-account2@gmail.com",
- "websites": [ ],
- "id": 2,
- "roles": [
- "regular-role2"
]
}
]
}
]
Update a generation school year, using its school year as a parameter
schoolYear required | string School year associated with a generation |
schoolYear | string New school year |
{- "schoolYear": "19-20"
}
{- "schoolYear": "19-20",
- "id": 1,
- "roles": [
- {
- "name": "section-role1",
- "permissions": [ ],
- "isSection": true,
- "id": 1,
- "associatedActivities": [
- {
- "permissions": [ ],
- "id": 1,
- "activity": {
- "title": "NIJobs",
- "description": "cool project",
- "teamMembers": [ ],
- "isArchived": false,
- "technologies": [ ],
- "id": 1
}
}
]
}, - {
- "name": "section-role2",
- "permissions": [ ],
- "isSection": true,
- "id": 2,
- "associatedActivities": [ ]
}, - {
- "name": "regular-role1",
- "permissions": [ ],
- "isSection": false,
- "id": 3,
- "associatedActivities": [
- {
- "permissions": [ ],
- "id": 2,
- "activity": {
- "title": "SINF",
- "description": "cool event",
- "teamMembers": [ ],
- "dateInterval": {
- "startDate": "10-10-2023"
}, - "id": 2
}
}
]
}, - {
- "name": "regular-role2",
- "permissions": [ ],
- "isSection": false,
- "id": 4,
- "associatedActivities": [ ]
}
]
}
The operation returns an array of posts, allowing to easily retrieve all the created posts.
[- {
- "title": "New test released",
- "body": "this is a test post",
- "publishDate": "02-07-2023",
- "lastUpdatedAt": "02-07-2023 01:46:13",
- "id": 1,
- "slug": "new-test-released"
}, - {
- "title": "NIAEFEUP gets a new president",
- "body": "New president promised to buy new chairs",
- "publishDate": "02-07-2023",
- "lastUpdatedAt": "02-07-2023 01:46:13",
- "id": 2
}
]
This endpoint operation creates a new post.
thumbnailPath | string Path for the post thumbnail image |
body | string Post body |
title | string Post title |
slug | string Short and friendly textual post identifier |
{- "title": "New test released",
- "body": "this is a test post",
- "slug": "new-test-released"
}
{- "title": "New test released",
- "body": "this is a test post",
- "publishDate": "02-07-2023",
- "lastUpdatedAt": "02-07-2023 01:46:13",
- "id": 1,
- "slug": "new-test-released"
}
This endpoint allows the retrieval of a single post using its ID. It might be used to generate the specific post page.
id required | string ID of the post to retrieve |
{- "title": "New test released",
- "body": "this is a test post",
- "publishDate": "02-07-2023",
- "lastUpdatedAt": "02-07-2023 01:46:13",
- "id": 1,
- "slug": "new-test-released"
}
Update a previously created post, using its ID.
id required | string ID of the post to update |
thumbnailPath | string Path for the post thumbnail image |
body | string Post body |
title | string Post title |
slug | string Short and friendly textual post identifier |
{- "title": "New test released",
- "body": "this is a test post",
- "slug": "aaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa"
}
{- "title": "New Title",
- "body": "New Body of the post",
- "publishDate": "02-07-2023",
- "lastUpdatedAt": "02-07-2023 01:46:13",
- "id": 1,
- "slug": "new-test-released"
}
This endpoint allows the retrieval of a single post using its slug. It might be used to generate the specific post page.
slug required | string Short and friendly textual post identifier |
{- "title": "New test released",
- "body": "this is a test post",
- "publishDate": "02-07-2023",
- "lastUpdatedAt": "02-07-2023 01:46:13",
- "id": 1,
- "slug": "new-test-released"
}
The operation returns an array of projects, allowing to easily retrieve all the created projects. This is useful for example in the frontend project page, where projects are displayed.
[- {
- "title": "Awesome project",
- "description": "this is a test project",
- "teamMembers": [
- {
- "name": "Test Account",
- "email": "test_account@test.com",
- "bio": "This is a test account",
- "birthDate": "28-07-2001",
- "websites": [
], - "id": 1
}
], - "slug": "awesome-project",
- "isArchived": false,
- "technologies": [
- "Java",
- "Kotlin",
- "Spring"
], - "id": 1
}, - {
- "title": "NIJobs",
- "description": "Job platform for students",
- "teamMembers": [ ],
- "isArchived": false,
- "technologies": [
- "ExpressJS",
- "React"
], - "id": 2
}
]
This endpoint operation creates a new project.
object Array of technologies used in the project | |
object Array with IDs of members associated with the project | |
isArchived | boolean If the project is no longer maintained |
description | string Project description |
title | string Project title |
slug | string Short and friendly textual event identifier |
{- "title": "Awesome project"
}
{- "title": "Awesome project",
- "description": "this is a test project",
- "teamMembers": [
- {
- "name": "Test Account",
- "email": "test_account@test.com",
- "bio": "This is a test account",
- "birthDate": "28-07-2001",
- "websites": [
], - "id": 1
}
], - "slug": "awesome-project",
- "isArchived": false,
- "technologies": [
- "Java",
- "Kotlin",
- "Spring"
], - "id": 1
}
This endpoint allows the retrieval of a single project using its ID. It might be used to generate the specific project page.
id required | string ID of the project to retrieve |
{- "title": "Awesome project",
- "description": "this is a test project",
- "teamMembers": [
- {
- "name": "Test Account",
- "email": "test_account@test.com",
- "bio": "This is a test account",
- "birthDate": "28-07-2001",
- "websites": [
], - "id": 1
}
], - "slug": "awesome-project",
- "isArchived": false,
- "technologies": [
- "Java",
- "Kotlin",
- "Spring"
], - "id": 1
}
Update a previously created project, using its ID.
id required | string ID of the project to update |
object Array of technologies used in the project | |
object Array with IDs of members associated with the project | |
isArchived | boolean If the project is no longer maintained |
description | string Project description |
title | string Project title |
slug | string Short and friendly textual event identifier |
{- "title": "Awesome project",
- "description": "this is a test project",
- "slug": "aaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa"
}
{- "title": "New Title",
- "description": "New description of the project",
- "teamMembers": [ ],
- "slug": "awesome-project",
- "isArchived": true,
- "technologies": [ ],
- "id": 1
}
This endpoint allows the retrieval of a single project using its slug.
slug required | string Short and friendly textual project identifier |
{- "title": "Awesome project",
- "description": "this is a test project",
- "teamMembers": [
- {
- "name": "Test Account",
- "email": "test_account@test.com",
- "bio": "This is a test account",
- "birthDate": "28-07-2001",
- "websites": [
], - "id": 1
}
], - "slug": "awesome-project",
- "isArchived": false,
- "technologies": [
- "Java",
- "Kotlin",
- "Spring"
], - "id": 1
}
This endpoint archives a project. This is useful to mark no longer maintained or complete projects.
id required | string ID of the project to archive |
{- "title": "Awesome project",
- "description": "this is a test project",
- "teamMembers": [
- {
- "name": "Test Account",
- "email": "test_account@test.com",
- "bio": "This is a test account",
- "birthDate": "28-07-2001",
- "websites": [
], - "id": 1
}
], - "slug": "awesome-project",
- "isArchived": true,
- "technologies": [
- "Java",
- "Kotlin",
- "Spring"
], - "id": 1
}
This endpoint unarchives a project. This is useful to mark previously archived projects as active.
id required | string ID of the project to unarchive |
{- "title": "proj1",
- "description": "very cool project",
- "teamMembers": [ ],
- "isArchived": false,
- "technologies": [
- "React",
- "TailwindCSS"
], - "id": 1
}
This operation adds a team member to a given project.
projectId required | string ID of the project to add the member to |
accountId required | string ID of the account to add |
{- "title": "Awesome project",
- "description": "this is a test project",
- "teamMembers": [
- {
- "name": "Test Account",
- "email": "test_account@test.com",
- "bio": "This is a test account",
- "birthDate": "28-07-2001",
- "websites": [
], - "id": 1
}, - {
- "name": "Another test Account",
- "email": "test2_account@test.com",
- "bio": "This is another test account",
- "birthDate": "04-04-2003",
- "websites": [
], - "id": 2
}
], - "slug": "awesome-project",
- "isArchived": false,
- "technologies": [
- "Java",
- "Kotlin",
- "Spring"
], - "id": 1
}
This operation removes a team member of a given project.
projectId required | string ID of the project to remove the member from |
accountId required | string ID of the account to remove |
{- "title": "Awesome project",
- "description": "this is a test project",
- "teamMembers": [ ],
- "slug": "awesome-project",
- "isArchived": false,
- "technologies": [
- "Java",
- "Kotlin",
- "Spring"
], - "id": 1
}