Appwrite
  1. teams
Appwrite
  • account
    • Delete Account
      DELETE
    • Get Account
      GET
    • Create Account
      POST
    • Update Account Email
      PATCH
    • Create Account JWT
      POST
    • Get Account Logs
      GET
    • Update Account Name
      PATCH
    • Update Account Password
      PATCH
    • Get Account Preferences
      GET
    • Update Account Preferences
      PATCH
    • Create Password Recovery
      POST
    • Complete Password Recovery
      PUT
    • Delete All Account Sessions
      DELETE
    • Get Account Sessions
      GET
    • Create Account Session
      POST
    • Create Anonymous Session
      POST
    • Create Account Session with OAuth2
      GET
    • Delete Account Session
      DELETE
    • Get Session By ID
      GET
    • Create Email Verification
      POST
    • Complete Email Verification
      PUT
  • avatars
    • Get Browser Icon
    • Get Credit Card Icon
    • Get Favicon
    • Get Country Flag
    • Get Image from URL
    • Get User Initials
    • Get QR Code
  • database
    • List Documents
    • Create Document
    • Delete Document
    • Get Document
    • Update Document
  • functions
    • List Executions
    • Create Execution
    • Get Execution
  • locale
    • Get User Locale
    • List Continents
    • List Countries
    • List EU Countries
    • List Countries Phone Codes
    • List Currencies
    • List Languages
  • storage
    • List Files
    • Create File
    • Delete File
    • Get File
    • Update File
    • Get File for Download
    • Get File Preview
    • Get File for View
  • teams
    • List Teams
      GET
    • Create Team
      POST
    • Delete Team
      DELETE
    • Get Team
      GET
    • Update Team
      PUT
    • Get Team Memberships
      GET
    • Create Team Membership
      POST
    • Delete Team Membership
      DELETE
    • Update Membership Roles
      PATCH
    • Update Team Membership Status
      PATCH
  1. teams

Get Team Memberships

GET
/teams/{teamId}/memberships
teams
Get a team members by the team unique ID. All team members have read access for this list of resources.
Request Request Example
Shell
JavaScript
Java
Swift
curl --location --request GET 'https://appwrite.io/v1/teams//memberships'
Response Response Example
{
    "memberships": [
        {
            "$id": "string",
            "confirm": true,
            "email": "string",
            "invited": 0,
            "joined": 0,
            "name": "string",
            "roles": [
                "string"
            ],
            "teamId": "string",
            "userId": "string"
        }
    ],
    "sum": 0
}

Request

Path Params
teamId
string 
required
Team unique ID.
Query Params
search
string 
optional
Search term to filter your list results. Max length: 256 chars.
limit
integer 
optional
Results limit value. By default will return maximum 25 results. Maximum of 100 results allowed per request.
offset
integer 
optional
Results offset. The default value is 0. Use this param to manage pagination.
orderType
string 
optional
Order result by ASC or DESC order.

Responses

🟢200Memberships List
application/json
Body
Memberships List
memberships
array[object (membership) {9}] 
required
List of memberships.
$id
string 
required
Membership ID.
confirm
boolean 
required
User confirmation status, true if the user has joined the team or false otherwise.
email
string 
required
User email address.
invited
integer <int32>
required
Date, the user has been invited to join the team in Unix timestamp.
joined
integer <int32>
required
Date, the user has accepted the invitation to join the team in Unix timestamp.
name
string 
required
User name.
roles
array[string]
required
User list of roles
teamId
string 
required
Team ID.
userId
string 
required
User ID.
sum
integer <int32>
required
Total sum of items in the list.
Modified at 2023-08-16 07:28:14
Previous
Update Team
Next
Create Team Membership
Built with