Team Memberships

GET

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

GET/memberships/find-membership

Response

200400403500

Membership found successfully

Body

application/json

idnumber

Example: 1

firstNamestring

Example: "John"

lastNamestring

Example: "Doe"

phonestring

Example: "123-456-7890"

rolestring

Example: "Member"

isActiveboolean

Example: true

invitationAcceptedboolean

Example: true

Request

JavaScriptCurlPython

const response = await fetch('/memberships/find-membership', {
    method: 'GET',
    headers: {},
});
const data = await response.json();

Response

200400403500

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

Retrieves the memberships of the authenticated user.

GET/memberships/me

Response

200400403500

Memberships retrieved successfully

Body

application/json

countnumber

Example: 5

membershipsarray of object

Request

JavaScriptCurlPython

const response = await fetch('/memberships/me', {
    method: 'GET',
    headers: {},
});
const data = await response.json();

Response

200400403500

{
  "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/memberships/archive

Body

application/json

Membership archiving data

idsarray of number

Response

200400403500

Memberships archived successfully

Body

application/json

any

Request

JavaScriptCurlPython

const response = await fetch('/memberships/archive', {
    method: 'PUT',
    headers: {
      "Content-Type": "application/json"
    },
    body: JSON.stringify({}),
});
const data = await response.json();

Response

200400403500

{
  "message": "Memberships archived successfully",
  "description": "<p>The memberships have been archived successfully.</p>",
  "__$markdownParsed": true
}

Restores multiple archived team memberships.

PUT/memberships/restore

Body

application/json

Membership restoration data

idsarray of number

teamRolestring

Example: "Member"

Response

200400403500

Memberships restored successfully

Body

application/json

any

Request

JavaScriptCurlPython

const response = await fetch('/memberships/restore', {
    method: 'PUT',
    headers: {
      "Content-Type": "application/json"
    },
    body: JSON.stringify({}),
});
const data = await response.json();

Response

200400403500

{
  "message": "Memberships restored successfully",
  "description": "<p>The memberships have been restored successfully.</p>",
  "__$markdownParsed": true
}

DELETE

Deletes multiple team memberships.

DELETE/memberships

Body

application/json

Membership deletion data

idsarray of number

Response

200400403500

Memberships deleted successfully

Body

application/json

any

Request

JavaScriptCurlPython

const response = await fetch('/memberships', {
    method: 'DELETE',
    headers: {
      "Content-Type": "application/json"
    },
    body: JSON.stringify({}),
});
const data = await response.json();

Response

200400403500

{
  "message": "Memberships deleted successfully",
  "description": "<p>The memberships have been deleted successfully.</p>",
  "__$markdownParsed": true
}