Team Memberships

GET

Finds the membership of the authenticated user in the current team.

get
Responses
200

Membership found successfully

application/json
get
/memberships/find-membership
GET /memberships/find-membership HTTP/1.1
Host: 
Accept: */*

{
  "id": 1,
  "firstName": "John",
  "lastName": "Doe",
  "phone": "123-456-7890",
  "role": "Member",
  "isActive": true,
  "invitationAccepted": true
}

Retrieves the memberships of the authenticated user.

get
Responses
200

Memberships retrieved successfully

application/json
get
/memberships/me
GET /memberships/me HTTP/1.1
Host: 
Accept: */*

{
  "count": 5,
  "memberships": [
    {
      "id": 1,
      "firstName": "John",
      "lastName": "Doe",
      "phone": "123-456-7890",
      "role": "Member",
      "isActive": true,
      "invitationAccepted": true
    }
  ]
}

PUT

Archives multiple team memberships.

put
Body
idsnumber[]OptionalExample: [1,2,3]
Responses
200

Memberships archived successfully

application/json
ResponseanyExample: {"message":"Memberships archived successfully","description":"The memberships have been archived successfully."}
put
/memberships/archive
PUT /memberships/archive HTTP/1.1
Host: 
Content-Type: application/json
Accept: */*
Content-Length: 15

{
  "ids": [
    1,
    2,
    3
  ]
}
{
  "message": "Memberships archived successfully",
  "description": "The memberships have been archived successfully."
}

Restores multiple archived team memberships.

put
Body
idsnumber[]OptionalExample: [1,2,3]
teamRolestringOptionalExample: Member
Responses
200

Memberships restored successfully

application/json
ResponseanyExample: {"message":"Memberships restored successfully","description":"The memberships have been restored successfully."}
put
/memberships/restore
PUT /memberships/restore HTTP/1.1
Host: 
Content-Type: application/json
Accept: */*
Content-Length: 35

{
  "ids": [
    1,
    2,
    3
  ],
  "teamRole": "Member"
}
{
  "message": "Memberships restored successfully",
  "description": "The memberships have been restored successfully."
}

DELETE

Deletes multiple team memberships.

delete
Body
idsnumber[]OptionalExample: [1,2,3]
Responses
200

Memberships deleted successfully

application/json
ResponseanyExample: {"message":"Memberships deleted successfully","description":"The memberships have been deleted successfully."}
delete
/memberships
DELETE /memberships HTTP/1.1
Host: 
Content-Type: application/json
Accept: */*
Content-Length: 15

{
  "ids": [
    1,
    2,
    3
  ]
}
{
  "message": "Memberships deleted successfully",
  "description": "The memberships have been deleted successfully."
}
PreviousTeamsNextUser Admin

Last updated