Get a ProjectMembership

GET/project-memberships/{projectMembershipId}/

API version

v2

Request method

GET

Operation ID

project-get-project-membership

---

Request

• projectMembershipIdstring

  required

  ID of the ProjectMembership to be retrieved.

Responses

Format

application/json

Description

Schema documentation

• emailstring (email)

  required

  Email used by the invited user.

• expiresAtstring (date-time)

  Time the ProjectMembership should expire at.

• idstring (uuid)

  required

  ID of the ProjectMembership.

• inheritedboolean

  required

  Whether the ProjectMembership was inherited from a CustomerMembership.

• inviteIdstring (uuid)

  ID of the ProjectInvite the membership was created from.

• memberSincestring (date-time)

  Date the projectMembership was created at.

• mfaboolean

  required

  MFA activated by the user.

• projectIdstring (uuid)

  required

  ID of the Project the membership is for.

• rolestring (one of: notset, owner, emailadmin, external)

  required
• userIdstring (uuid)

  required

  ID of the user the ProjectMembership is for.

Example

{
  "email": "email@mittwald.example",
  "expiresAt": "2024-11-08T18:07:42.953Z",
  "id": "f0f86186-0a5a-45b2-aa33-502777496347",
  "inherited": true,
  "inviteId": "f0f86186-0a5a-45b2-aa33-502777496347",
  "memberSince": "2024-11-08T18:07:42.953Z",
  "mfa": true,
  "projectId": "f0f86186-0a5a-45b2-aa33-502777496347",
  "role": "notset",
  "userId": "f0f86186-0a5a-45b2-aa33-502777496347"
}

JSON Schema

{
  "properties": {
    "email": {
      "description": "Email used by the invited user.",
      "format": "email",
      "type": "string"
    },
    "expiresAt": {
      "description": "Time the ProjectMembership should expire at.",
      "format": "date-time",
      "type": "string"
    },
    "id": {
      "description": "ID of the ProjectMembership.",
      "format": "uuid",
      "type": "string"
    },
    "inherited": {
      "description": "Whether the ProjectMembership was inherited from a CustomerMembership.",
      "type": "boolean"
    },
    "inviteId": {
      "description": "ID of the ProjectInvite the membership was created from.",
      "format": "uuid",
      "type": "string"
    },
    "memberSince": {
      "description": "Date the projectMembership was created at.",
      "format": "date-time",
      "type": "string"
    },
    "mfa": {
      "description": "MFA activated by the user.",
      "type": "boolean"
    },
    "projectId": {
      "description": "ID of the Project the membership is for.",
      "format": "uuid",
      "type": "string"
    },
    "role": {
      "enum": [
        "notset",
        "owner",
        "emailadmin",
        "external"
      ],
      "type": "string"
    },
    "userId": {
      "description": "ID of the user the ProjectMembership is for.",
      "format": "uuid",
      "type": "string"
    }
  },
  "required": [
    "id",
    "projectId",
    "userId",
    "role",
    "inherited",
    "email",
    "mfa"
  ],
  "type": "object"
}

Usage examples

cURL

$ curl \
    --fail \
    --location \
    -H "Authorization: Bearer $MITTWALD_API_TOKEN" \
    https://api.mittwald.de/v2/project-memberships/string

JavaScript SDK

import { MittwaldAPIV2Client } from "@mittwald/api-client";
import { assertStatus } from "@mittwald/api-client-commons";
  
const client = MittwaldAPIClient.newWithToken(process.env.MITTWALD_API_TOKEN);
const response = await client.project.getProjectMembership({
  "projectMembershipId": "string"
});

assertStatus(response, 200);
  

PHP SDK

use \Mittwald\ApiClient\Generated\V2\Clients\Project\GetProjectMembership\GetProjectMembershipRequest;
  
$client = MittwaldAPIClient::newWithToken(getenv('MITTWALD_API_TOKEN'));

$request = (new GetProjectMembershipRequest(
  projectMembershipId: "string"
));
$response = $client->project()->getProjectMembership($request);

var_dump($response->getBody();