Invite

The "Invite" section houses endpoints related to inviting team members, removing team members, accepting invitations to join a team, and canceling team invitations.

Invite a member

POST {{BASE_URL}}/api/teams/{id}/invite

Invite a user to a specific team.

Path Parameters

Name	Type	Description
id*	String	Team ID

Headers

Name	Type	Description
Authorization*	String	Bearer Token

Request Body

Name	Type	Description
emails*	[String]	["[email protected]"]

200: OK

{"status":"ok"}

Accept invitation

POST {{BASE_URL}}/api/invite/{id}

Accept an invitation to join the team.

Path Parameters

Name	Type	Description
id*	String	Invite ID

Headers

Name	Type	Description
Authorization*	String	Bearer Token

Request Body

Name	Type	Description
email*	String
password*	String

200: OK

{
    "userToken": "userToken",
    "vaultToken": "teamToken"
}

Invitation list

GET {{BASE_URL}}/api/teams/{id}/invite

Get a list of invitations to the team.

Path Parameters

Name	Type	Description
id*	String	Team ID

Headers

Name	Type	Description
Authorization*	String	Bearer Token

200: OK

[{"_id":"6548fd8dff600e06af2a95e2","email":"[email protected]"}]

Get invitation

GET {{BASE_URL}}/api/invite/{id}

Get team invitation information by unique id.

Path Parameters

Name	Type	Description
id*	String	Invite ID

Headers

Name	Type	Description
Authorization*	String	Bearer Token

200: OK

{"_id":"6548fd8dff600e06af2a95e2","email":"[email protected]"}

Cancel invitation

DELETE {{BASE_URL}}/api/teams/{id}/invite/{inviteId}

Cancel the invitation to the team.

Path Parameters

Name	Type	Description
id*	String	Team ID
inviteId	String	Invite id

Headers

Name	Type	Description
Authorization*	String	Bearer Token

200: OK

true