6.2 KiB
Teams Service
List Teams
GET https://appwrite.test/v1/teams
** Get a list of all the current user teams. You can use the query params to filter your results. On admin mode, this endpoint will return a list of all of the project teams. Learn more about different API modes. **
Parameters
| Field Name | Type | Description | Default |
|---|---|---|---|
| search | string | Search term to filter your list results. | |
| limit | integer | Results limit value. By default will return maximum 25 results. Maximum of 100 results allowed per request. | 25 |
| offset | integer | Results offset. The default value is 0. Use this param to manage pagination. | 0 |
| orderType | string | Order result by ASC or DESC order. | ASC |
Create Team
POST https://appwrite.test/v1/teams
** Create a new team. The user who creates the team will automatically be assigned as the owner of the team. The team owner can invite new members, who will be able add new owners and update or delete the team from your project. **
Parameters
| Field Name | Type | Description | Default |
|---|---|---|---|
| name | string | Team name. | |
| roles | array | User roles array. Use this param to set the roles in the team for the user who created the team. The default role is owner, a role can be any string. | ["owner"] |
Get Team
GET https://appwrite.test/v1/teams/{teamId}
** Get team by its unique ID. All team members have read access for this resource. **
Parameters
| Field Name | Type | Description | Default |
|---|---|---|---|
| teamId | string | Required Team unique ID. |
Update Team
PUT https://appwrite.test/v1/teams/{teamId}
** Update team by its unique ID. Only team owners have write access for this resource. **
Parameters
| Field Name | Type | Description | Default |
|---|---|---|---|
| teamId | string | Required Team unique ID. | |
| name | string | Team name. |
Delete Team
DELETE https://appwrite.test/v1/teams/{teamId}
** Delete team by its unique ID. Only team owners have write access for this resource. **
Parameters
| Field Name | Type | Description | Default |
|---|---|---|---|
| teamId | string | Required Team unique ID. |
Get Team Members
GET https://appwrite.test/v1/teams/{teamId}/members
** Get team members by the team unique ID. All team members have read access for this list of resources. **
Parameters
| Field Name | Type | Description | Default |
|---|---|---|---|
| teamId | string | Required Team unique ID. |
Create Team Membership
POST https://appwrite.test/v1/teams/{teamId}/memberships
** Use this endpoint to invite a new member to your team. An email with a link to join the team will be sent to the new member email address. If member doesn't exists in the project it will be automatically created.
Use the redirect parameter to redirect the user from the invitation email back to your app. When the user is redirected, use the /teams/{teamId}/memberships/{inviteId}/status endpoint to finally join the user to the team.
Please notice that in order to avoid a Redirect Attacks the only valid redirect URL's are the once from domains you have set when added your platforms in the console interface. **
Parameters
| Field Name | Type | Description | Default |
|---|---|---|---|
| teamId | string | Required Team unique ID. | |
| string | New team member email address. | ||
| name | string | New team member name. | |
| roles | array | Invite roles array. Learn more about roles and permissions. | |
| redirect | string | Reset page to redirect user back to your app from the invitation email. |
Delete Team Membership
DELETE https://appwrite.test/v1/teams/{teamId}/memberships/{inviteId}
** This endpoint allows a user to leave a team or for a team owner to delete the membership of any other team member. **
Parameters
| Field Name | Type | Description | Default |
|---|---|---|---|
| teamId | string | Required Team unique ID. | |
| inviteId | string | Required Invite unique ID |
Create Team Membership (Resend)
POST https://appwrite.test/v1/teams/{teamId}/memberships/{inviteId}/resend
** Use this endpoint to resend your invitation email for a user to join a team. **
Parameters
| Field Name | Type | Description | Default |
|---|---|---|---|
| teamId | string | Required Team unique ID. | |
| inviteId | string | Required Invite unique ID. | |
| redirect | string | Reset page to redirect user back to your app from the invitation email. |
Update Team Membership Status
PATCH https://appwrite.test/v1/teams/{teamId}/memberships/{inviteId}/status
** Use this endpoint to let user accept an invitation to join a team after he is being redirect back to your app from the invitation email. Use the success and failure URL's to redirect users back to your application after the request completes.
Please notice that in order to avoid a Redirect Attacks the only valid redirect URL's are the once from domains you have set when added your platforms in the console interface.
When not using the success or failure redirect arguments this endpoint will result with a 200 status code on success and with 401 status error on failure. This behavior was applied to help the web clients deal with browsers who don't allow to set 3rd party HTTP cookies needed for saving the account session token. **
Parameters
| Field Name | Type | Description | Default |
|---|---|---|---|
| teamId | string | Required Team unique ID. | |
| inviteId | string | Required Invite unique ID | |
| userId | string | User unique ID | |
| secret | string | Secret Key | |
| success | string | Redirect when registration succeed | |
| failure | string | Redirect when registration failed |