Team Members

List members of a team

get

https://api.example.comhttps://staging-api.example.com

/memberships/teams/{teamId}/members

Gets the list of all members that belong to the specified team

Path parameters

teamIdstring · uuidRequired

Unique ID of the team

Example: team123-def6-7890-abcd-ef1234567890

Query parameters

pageinteger · min: 1Optional

Page number for pagination

Default: 1Example: 1

limitinteger · min: 1 · max: 100Optional

Number of items per page

Default: 20Example: 20

Responses

200

List of team members retrieved successfully

application/json

500

Internal server error

application/json

get

/memberships/teams/{teamId}/members

HTTPcURLJavaScriptPython

GET /memberships/teams/{teamId}/members HTTP/1.1
Host: api.example.com
Accept: */*

{
  "data": [
    {
      "id": "member123-def6-7890-abcd-ef1234567890",
      "userId": "456e7890-e89b-12d3-a456-426614174001",
      "teamId": "team123-def6-7890-abcd-ef1234567890",
      "user": {
        "id": "456e7890-e89b-12d3-a456-426614174001",
        "email": "[e-mail]",
        "firstName": "John",
        "lastName": "Doe",
        "avatar": "https://example.com/avatars/john.jpg"
      },
      "role": "member",
      "joinedAt": "2024-01-15T10:30:00Z",
      "updatedAt": "2024-01-20T14:45:00Z",
      "metadata": {
        "position": "Frontend Developer",
        "level": "Senior"
      }
    }
  ],
  "pagination": {
    "page": 1,
    "limit": 20,
    "total": 1,
    "totalPages": 1,
    "hasNext": false,
    "hasPrev": false
  }
}

Add member to team

post

https://api.example.comhttps://staging-api.example.com

/memberships/teams/{teamId}/members

Adds an existing organization user to the specified team

Path parameters

teamIdstring · uuidRequired

Unique ID of the team

Example: team123-def6-7890-abcd-ef1234567890

Body

application/json

userIdstring · uuidRequired

ID of the existing organization user to add to the team

Example: 456e7890-e89b-12d3-a456-426614174001

rolestring · enumOptional

Role of the user in the team

Default: memberExample: memberPossible values:

Responses

201

Member successfully added to team

application/json

500

Internal server error

application/json

post

/memberships/teams/{teamId}/members

HTTPcURLJavaScriptPython

POST /memberships/teams/{teamId}/members HTTP/1.1
Host: api.example.com
Content-Type: application/json
Accept: */*
Content-Length: 127

{
  "userId": "456e7890-e89b-12d3-a456-426614174001",
  "role": "member",
  "metadata": {
    "position": "Frontend Developer",
    "level": "Senior"
  }
}

{
  "id": "member123-def6-7890-abcd-ef1234567890",
  "userId": "456e7890-e89b-12d3-a456-426614174001",
  "teamId": "team123-def6-7890-abcd-ef1234567890",
  "user": {
    "id": "456e7890-e89b-12d3-a456-426614174001",
    "email": "[e-mail]",
    "firstName": "John",
    "lastName": "Doe",
    "avatar": "https://example.com/avatars/john.jpg"
  },
  "role": "member",
  "joinedAt": "2024-01-15T10:30:00Z",
  "updatedAt": "2024-01-15T10:30:00Z",
  "metadata": {
    "position": "Frontend Developer",
    "level": "Senior"
  }
}

Get team member information

get

https://api.example.comhttps://staging-api.example.com

/memberships/teams/{teamId}/members/{memberId}

Gets the information of a specific team member

Path parameters

teamIdstring · uuidRequired

Unique ID of the team

Example: team123-def6-7890-abcd-ef1234567890

memberIdstring · uuidRequired

Unique ID of the team member

Example: member123-def6-7890-abcd-ef1234567890

Responses

200

Team member information retrieved successfully

application/json

idstring · uuidOptional

Unique team membership ID

Example: member123-def6-7890-abcd-ef1234567890

userIdstring · uuidOptional

ID of the user

Example: 456e7890-e89b-12d3-a456-426614174001

teamIdstring · uuidOptional

ID of the team

Example: team123-def6-7890-abcd-ef1234567890

rolestring · enumOptional

Role of the user in the team

Example: memberPossible values:

joinedAtstring · date-timeOptional

Date and time when the user joined the team

Example: 2024-01-15T10:30:00Z

updatedAtstring · date-timeOptional

Date and time of last update

Example: 2024-01-20T14:45:00Z

500

Internal server error

application/json

get

/memberships/teams/{teamId}/members/{memberId}

HTTPcURLJavaScriptPython

GET /memberships/teams/{teamId}/members/{memberId} HTTP/1.1
Host: api.example.com
Accept: */*

{
  "id": "member123-def6-7890-abcd-ef1234567890",
  "userId": "456e7890-e89b-12d3-a456-426614174001",
  "teamId": "team123-def6-7890-abcd-ef1234567890",
  "user": {
    "id": "456e7890-e89b-12d3-a456-426614174001",
    "email": "[e-mail]",
    "firstName": "John",
    "lastName": "Doe",
    "avatar": "https://example.com/avatars/john.jpg"
  },
  "role": "member",
  "joinedAt": "2024-01-15T10:30:00Z",
  "updatedAt": "2024-01-20T14:45:00Z",
  "metadata": {
    "position": "Frontend Developer",
    "level": "Senior"
  }
}

Update team member

put

https://api.example.comhttps://staging-api.example.com

/memberships/teams/{teamId}/members/{memberId}

Updates the role and information of a team member

Path parameters

teamIdstring · uuidRequired

Unique ID of the team

Example: team123-def6-7890-abcd-ef1234567890

memberIdstring · uuidRequired

Unique ID of the team member

Example: member123-def6-7890-abcd-ef1234567890

Body

application/json

rolestring · enumOptional

New role for the team member

Example: leadPossible values:

Responses

200

Team member updated successfully

application/json

idstring · uuidOptional

Unique team membership ID

Example: member123-def6-7890-abcd-ef1234567890

userIdstring · uuidOptional

ID of the user

Example: 456e7890-e89b-12d3-a456-426614174001

teamIdstring · uuidOptional

ID of the team

Example: team123-def6-7890-abcd-ef1234567890

rolestring · enumOptional

Role of the user in the team

Example: memberPossible values:

joinedAtstring · date-timeOptional

Date and time when the user joined the team

Example: 2024-01-15T10:30:00Z

updatedAtstring · date-timeOptional

Date and time of last update

Example: 2024-01-20T14:45:00Z

500

Internal server error

application/json

put

/memberships/teams/{teamId}/members/{memberId}

HTTPcURLJavaScriptPython

PUT /memberships/teams/{teamId}/members/{memberId} HTTP/1.1
Host: api.example.com
Content-Type: application/json
Accept: */*
Content-Length: 131

{
  "role": "lead",
  "metadata": {
    "position": "Tech Lead",
    "level": "Senior",
    "responsibilities": "Team coordination and technical decisions"
  }
}

{
  "id": "member123-def6-7890-abcd-ef1234567890",
  "userId": "456e7890-e89b-12d3-a456-426614174001",
  "teamId": "team123-def6-7890-abcd-ef1234567890",
  "user": {
    "id": "456e7890-e89b-12d3-a456-426614174001",
    "email": "[e-mail]",
    "firstName": "John",
    "lastName": "Doe",
    "avatar": "https://example.com/avatars/john.jpg"
  },
  "role": "lead",
  "joinedAt": "2024-01-15T10:30:00Z",
  "updatedAt": "2024-01-22T16:30:00Z",
  "metadata": {
    "position": "Tech Lead",
    "level": "Senior",
    "responsibilities": "Team coordination and technical decisions"
  }
}

Remove member from team

delete

https://api.example.comhttps://staging-api.example.com

/memberships/teams/{teamId}/members/{memberId}

Removes a member from the specified team

Path parameters

teamIdstring · uuidRequired

Unique ID of the team

Example: team123-def6-7890-abcd-ef1234567890

memberIdstring · uuidRequired

Unique ID of the team member to remove

Example: member123-def6-7890-abcd-ef1234567890

Responses

200

Member successfully removed from team

application/json

successbooleanRequired

Indicates if the operation was successful

Example: true

messagestringRequired

Descriptive success message

Example: Operation completed successfully

500

Internal server error

application/json

delete

/memberships/teams/{teamId}/members/{memberId}

HTTPcURLJavaScriptPython

DELETE /memberships/teams/{teamId}/members/{memberId} HTTP/1.1
Host: api.example.com
Accept: */*

{
  "success": true,
  "message": "Member successfully removed from team"
}