Get group membership

v1.0.0

Retrieves a specific group membership. Only admins of this group or users with admin-level permissions will be able to use this API.

Input

{
  "type": "object",
  "properties": {
    "fields": {
      "type": "array",
      "items": {
        "type": "string"
      }
    },
    "group_membership_id": {
      "type": "string"
    }
  },
  "required": [
    "group_membership_id"
  ],
  "additionalProperties": false
}

Output

{
  "type": "object",
  "description": "Membership is used to signify that a user is part of a\ngroup.",
  "properties": {
    "created_at": {
      "type": "string",
      "format": "date-time",
      "description": "The time this membership was created."
    },
    "group": {
      "type": "object"
    },
    "id": {
      "type": "string",
      "description": "The unique identifier for this group membership"
    },
    "modified_at": {
      "type": "string",
      "format": "date-time",
      "description": "The time this membership was last modified."
    },
    "role": {
      "type": "string",
      "description": "The role of the user in the group.",
      "enum": [
        "member",
        "admin"
      ]
    },
    "type": {
      "type": "string",
      "description": "`group_membership`",
      "enum": [
        "group_membership"
      ]
    },
    "user": {
      "type": "object"
    }
  }
}