getTeamMember (v1)

Retrieve team member

Overview

Retrieve internal team member details including status, assigned roles and the permissions granted through those roles.

GET (/internal/v1/parties/{organisationPartyId}/teams/{teamId}/members/{memberId})

Parameters

  • organisationPartyId (path) (required): The unique identifier of the organisation party.
  • teamId (path) (required): The unique identifier of the team.
  • memberId (path) (required): The unique identifier of the team member.
  • X-Request-ID (header): Request ID used for tracing. A new one will be generated if not provided.

Responses

200 OK

Internal representation of a team member’s status and assigned roles.

400 Bad Request

401 Unauthorized

404 Not Found

500 Internal Server Error

Architecture

6 properties

Internal representation of a team member's status and assigned roles.

status string

Status of a team member.

Allowed values: PENDING ACTIVE SUSPENDED
roles array [string]

The set of role IDs assigned to the member.

permissions array [object]

The permissions granted to the member through their assigned role.

7 properties
code string
Allowed values: urn:plmr:teams:api:BAD_REQUEST urn:plmr:teams:api:INVALID_PARAM urn:plmr:teams:api:WEB_APPLICATION
message string
requestId string
fieldErrors array [object]
3 properties
code string
Allowed values: urn:plmr:teams:api:UNAUTHORIZED
message string
requestId string
3 properties
code string
Allowed values: urn:plmr:teams:api:RESOURCE_UNKNOWN urn:plmr:teams:api:TEAM_NOT_FOUND urn:plmr:teams:api:MEMBER_NOT_FOUND
message string
requestId string
3 properties
code string
Allowed values: urn:plmr:teams:api:INTERNAL_SERVER_ERROR
message string
requestId string