---
updatedAt: 2026-08-21T11:06:34.000Z
agentTools:
  projectIndex: https://developer.bigpicture.one/llms.txt
---

# Get team members

Retrieves a team with its members and their memberships in a given box. If boxId is not provided, the first accessible box of the team is used.

On-premise availability - BigPicture versions equal to or greater than 8.70.11.3

# OpenAPI definition

```json
{
  "openapi": "3.0.1",
  "info": {
    "title": "BigPicture Data Center API",
    "version": "latest"
  },
  "servers": [
    {
      "url": "{base_url}/",
      "description": "The production API server",
      "variables": {
        "basePath": {
          "default": "your_server_path"
        }
      }
    }
  ],
  "paths": {
    "/public/ppm/team/{teamId}/memberships": {
      "get": {
        "tags": [
          "Teams"
        ],
        "summary": "Get team members",
        "description": "Retrieves a team with its members and their memberships in a given box. If boxId is not provided, the first accessible box of the team is used.\n\nOn-premise availability - BigPicture versions equal to or greater than 8.70.11.3",
        "operationId": "getTeamMembers",
        "parameters": [
          {
            "name": "teamId",
            "in": "path",
            "required": true,
            "schema": {
              "$ref": "#/components/schemas/com.softwareplant.ppm.resource.api.TeamId"
            }
          },
          {
            "name": "boxId",
            "in": "query",
            "schema": {
              "type": "string"
            }
          }
        ],
        "responses": {
          "200": {
            "description": "Team members returned successfully.",
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/com.softwareplant.ppm.boxarea.resource.team.publicapi.membership.v1.response.TeamMembershipsPublicApiResponse"
                }
              }
            }
          },
          "401": {
            "description": "Unauthorized. API token is missing or invalid."
          },
          "403": {
            "description": "Forbidden. Token has no required permissions."
          }
        }
      }
    }
  },
  "components": {
    "schemas": {
      "com.softwareplant.util.lang.SimpleString": {
        "type": "object",
        "properties": {
          "value": {
            "type": "string"
          }
        }
      },
      "com.softwareplant.ppm.boxarea.resource.team.publicapi.v1.dto.ResourceSkillItemDTO": {
        "type": "object",
        "properties": {
          "startDate": {
            "type": "string",
            "example": "2022-03-05"
          },
          "endDate": {
            "type": "string",
            "nullable": true,
            "example": "2022-04-08"
          },
          "skill": {
            "$ref": "#/components/schemas/com.softwareplant.ppm.boxarea.resource.team.publicapi.v1.dto.SkillDTO"
          }
        }
      },
      "com.softwareplant.ppm.boxarea.resource.team.publicapi.v1.dto.SkillDTO": {
        "type": "object",
        "properties": {
          "id": {
            "type": "integer",
            "format": "int32",
            "example": 2
          },
          "name": {
            "type": "string",
            "example": "Developer"
          },
          "code": {
            "type": "string",
            "example": "DEV"
          }
        }
      },
      "com.softwareplant.ppm.boxarea.resource.team.publicapi.v1.dto.TeamDTO": {
        "type": "object",
        "properties": {
          "teamId": {
            "type": "integer",
            "format": "int32",
            "example": 1
          },
          "code": {
            "type": "string",
            "example": "Team Code"
          },
          "color": {
            "type": "string",
            "example": "RED",
            "enum": [
              "darkBlue",
              "blue",
              "lightBlue",
              "cyan",
              "lightCyan",
              "purple",
              "lightPurple",
              "green",
              "lightGreen",
              "orange",
              "lightOrange",
              "yellow",
              "lightYellow",
              "red",
              "lightRed",
              "white",
              "lightGray",
              "darkGray",
              "gray",
              "black"
            ]
          },
          "name": {
            "type": "string",
            "example": "Team Name"
          },
          "creationBoxId": {
            "type": "string",
            "example": "PROG-1"
          },
          "members": {
            "type": "array",
            "items": {
              "$ref": "#/components/schemas/com.softwareplant.ppm.boxarea.resource.team.publicapi.v1.dto.TeamMemberDTO"
            }
          }
        },
        "description": "Team with its members and memberships after updating a membership."
      },
      "com.softwareplant.ppm.boxarea.resource.team.publicapi.v1.dto.TeamMemberDTO": {
        "type": "object",
        "properties": {
          "individualId": {
            "type": "string",
            "example": "EXT_USER@2@user"
          },
          "profileURL": {
            "type": "string",
            "nullable": true,
            "example": "https://{JiraBaseURL}/people/{profileId}"
          },
          "memberships": {
            "type": "array",
            "items": {
              "$ref": "#/components/schemas/com.softwareplant.ppm.boxarea.resource.team.publicapi.v1.dto.TeamMembershipDTO"
            }
          },
          "skills": {
            "type": "array",
            "items": {
              "$ref": "#/components/schemas/com.softwareplant.ppm.boxarea.resource.team.publicapi.v1.dto.ResourceSkillItemDTO"
            }
          },
          "name": {
            "type": "string",
            "nullable": true,
            "example": "John Smith"
          },
          "userKey": {
            "type": "string",
            "description": "External platform user identifier (e.g. Jira account id)",
            "example": "712020:40e4a8eb-971b-4633-aa9a-79bdc62fd70c"
          }
        },
        "description": "An object that represents a member assigned to a team."
      },
      "com.softwareplant.ppm.boxarea.resource.team.publicapi.v1.dto.TeamMembershipDTO": {
        "type": "object",
        "properties": {
          "percentageAvailability": {
            "type": "integer",
            "description": "A member availability in a team in percentage.",
            "format": "int32",
            "example": 100
          },
          "startDate": {
            "type": "string",
            "format": "date",
            "example": "2023-01-01"
          },
          "endDate": {
            "type": "string",
            "format": "date",
            "example": "2023-12-31"
          }
        }
      },
      "com.softwareplant.ppm.resource.api.TeamId": {
        "type": "object",
        "properties": {
          "internal": {
            "type": "integer",
            "format": "int32"
          },
          "dataTypeId": {
            "type": "string"
          },
          "multiValueType": {
            "type": "boolean"
          },
          "histogram": {
            "type": "boolean"
          },
          "elementsAsStrings": {
            "type": "array",
            "items": {
              "$ref": "#/components/schemas/com.softwareplant.util.lang.SimpleString"
            }
          }
        }
      },
      "com.softwareplant.ppm.boxarea.resource.team.publicapi.membership.v1.response.TeamMembershipsPublicApiResponse": {
        "type": "object",
        "properties": {
          "team": {
            "$ref": "#/components/schemas/com.softwareplant.ppm.boxarea.resource.team.publicapi.v1.dto.TeamDTO"
          }
        }
      }
    }
  },
  "x-readme": {
    "headers": [
      {
        "key": "Authorization",
        "value": "APIToken paste_your_api_token_here"
      }
    ],
    "explorer-enabled": false,
    "samples-languages": [
      "shell",
      "http",
      "java"
    ]
  }
}
```