Skip to content
Get Started

List

client.orgs.memberships.list(stringorgID, RequestOptionsoptions?): MembershipListResponse { id, role, user }
get/v2/orgs/{org_id}/memberships

List all memberships of an org

ParametersExpand Collapse
orgID: string
ReturnsExpand Collapse
MembershipListResponse = Array<MembershipListResponseItem>
id: string

The id of the membership

formatuuid
role: "owner" | "member" | null

The role of the member

Accepts one of the following:
"owner"
"member"
user: User { id, username }
id: string

The id of the user

formatuuid
username: string | null

The username of the user

List
import ValTown from "npm:@valtown/sdk";

const client = new ValTown();

const memberships = await client.orgs.memberships.list('182bd5e5-6e1a-4fe4-a799-aa6d9a6ab26e');

console.log(memberships);
[
  {
    "id": "182bd5e5-6e1a-4fe4-a799-aa6d9a6ab26e",
    "role": "owner",
    "user": {
      "id": "182bd5e5-6e1a-4fe4-a799-aa6d9a6ab26e",
      "username": "username"
    }
  }
]
Returns Examples
[
  {
    "id": "182bd5e5-6e1a-4fe4-a799-aa6d9a6ab26e",
    "role": "owner",
    "user": {
      "id": "182bd5e5-6e1a-4fe4-a799-aa6d9a6ab26e",
      "username": "username"
    }
  }
]