Team Memberships

GET

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

get

Responses

200

Membership found successfully

application/json

idnumberOptionalExample: 1

firstNamestringOptionalExample: John

lastNamestringOptionalExample: Doe

phonestringOptionalExample: 123-456-7890

rolestringOptionalExample: Member

isActivebooleanOptionalExample: true

invitationAcceptedbooleanOptionalExample: true

400

Membership not found

application/json

403

Access denied

application/json

500

Internal server error

application/json

get/memberships/find-membership

HTTPcURLJavaScriptPython

GET /memberships/find-membership HTTP/1.1
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

countnumberOptionalExample: 5

400

Invalid parameters

application/json

403

Access denied

application/json

500

Internal server error

application/json

get/memberships/me

HTTPcURLJavaScriptPython

GET /memberships/me HTTP/1.1
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

application/json

idsnumber[]OptionalExample: [1,2,3]

Responses

200

Memberships archived successfully

application/json

anyOptionalExample: {"message":"Memberships archived successfully","description":"The memberships have been archived successfully."}

400

One or more memberships not found

application/json

403

Access denied

application/json

500

Internal server error

application/json

put/memberships/archive

HTTPcURLJavaScriptPython

PUT /memberships/archive HTTP/1.1
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

application/json

idsnumber[]OptionalExample: [1,2,3]

teamRolestringOptionalExample: Member

Responses

200

Memberships restored successfully

application/json

anyOptionalExample: {"message":"Memberships restored successfully","description":"The memberships have been restored successfully."}

400

One or more memberships not found

application/json

403

Access denied

application/json

500

Internal server error

application/json

put/memberships/restore

HTTPcURLJavaScriptPython

PUT /memberships/restore HTTP/1.1
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

application/json

idsnumber[]OptionalExample: [1,2,3]

Responses

200

Memberships deleted successfully

application/json

anyOptionalExample: {"message":"Memberships deleted successfully","description":"The memberships have been deleted successfully."}

400

One or more memberships not found

application/json

403

Access denied

application/json

500

Internal server error

application/json

delete/memberships

HTTPcURLJavaScriptPython

DELETE /memberships HTTP/1.1
Content-Type: application/json
Accept: */*
Content-Length: 15

{
  "ids": [
    1,
    2,
    3
  ]
}

{
  "message": "Memberships deleted successfully",
  "description": "The memberships have been deleted successfully."
}