Team Memberships

GET

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

get

Responses

application/json

application/json

application/json

application/json

cURL

JavaScript

Python

HTTP

cURL

curl -L \
  --url '/memberships/find-membership'

200

400

403

500

200

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

Membership found successfully

Retrieves the memberships of the authenticated user.

get

Responses

application/json

application/json

application/json

application/json

cURL

JavaScript

Python

HTTP

cURL

curl -L \
  --url '/memberships/me'

200

400

403

500

200

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

Memberships retrieved successfully

PUT

Archives multiple team memberships.

put

Body

idsnumber[]optional

Example: [1,2,3]

Responses

application/json

application/json

application/json

application/json

cURL

JavaScript

Python

HTTP

cURL

curl -L \
  --request PUT \
  --url '/memberships/archive' \
  --header 'Content-Type: application/json' \
  --data '{
    "ids": [
      1,
      2,
      3
    ]
  }'

200

400

403

500

200

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

Memberships archived successfully

Restores multiple archived team memberships.

put

Body

idsnumber[]optional

Example: [1,2,3]

teamRolestringoptional

Example: Member

Responses

application/json

application/json

application/json

application/json

cURL

JavaScript

Python

HTTP

cURL

curl -L \
  --request PUT \
  --url '/memberships/restore' \
  --header 'Content-Type: application/json' \
  --data '{
    "ids": [
      1,
      2,
      3
    ],
    "teamRole": "Member"
  }'

200

400

403

500

200

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

Memberships restored successfully

DELETE

Deletes multiple team memberships.

delete

Body

idsnumber[]optional

Example: [1,2,3]

Responses

application/json

application/json

application/json

application/json

cURL

JavaScript

Python

HTTP

cURL

curl -L \
  --request DELETE \
  --url '/memberships' \
  --header 'Content-Type: application/json' \
  --data '{
    "ids": [
      1,
      2,
      3
    ]
  }'

200

400

403

500

200

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

Memberships deleted successfully