Memberships

Get Organization Membership

client.Organizations.Memberships.Get(ctx, organizationID, membershipID) (*OrganizationMembership, error)

GET/v1/organizations/{organization_id}/memberships/{membership_id}

List Organization Memberships

client.Organizations.Memberships.List(ctx, organizationID, query) (*Cursor[OrganizationMembership], error)

GET/v1/organizations/{organization_id}/memberships

Update Organization Membership

client.Organizations.Memberships.Update(ctx, organizationID, membershipID, body) (*OrganizationMembership, error)

PATCH/v1/organizations/{organization_id}/memberships/{membership_id}

Delete Organization Membership

client.Organizations.Memberships.Delete(ctx, organizationID, membershipID) error

DELETE/v1/organizations/{organization_id}/memberships/{membership_id}

ModelsExpand Collapse

type OrganizationMembership struct{…}

Organization membership details.

ID string

Membership ID.

CreatedAt Time

When the membership was created.

formatdate-time

OrganizationID string

Organization ID.

Role OrganizationMembershipRole

Role of the user in the organization.

One of the following:

const OrganizationMembershipRoleOwner OrganizationMembershipRole = "owner"

const OrganizationMembershipRoleAdmin OrganizationMembershipRole = "admin"

const OrganizationMembershipRoleBilling OrganizationMembershipRole = "billing"

const OrganizationMembershipRoleMember OrganizationMembershipRole = "member"

UpdatedAt Time

When the membership was updated.

formatdate-time

UserID string

User ID.

type OrganizationMembershipList struct{…}

Items []OrganizationMembership

ID string

Membership ID.

CreatedAt Time

When the membership was created.

formatdate-time

OrganizationID string

Organization ID.

Role OrganizationMembershipRole

Role of the user in the organization.

One of the following:

const OrganizationMembershipRoleOwner OrganizationMembershipRole = "owner"

const OrganizationMembershipRoleAdmin OrganizationMembershipRole = "admin"

const OrganizationMembershipRoleBilling OrganizationMembershipRole = "billing"

const OrganizationMembershipRoleMember OrganizationMembershipRole = "member"

UpdatedAt Time

When the membership was updated.

formatdate-time

UserID string

User ID.

Pagination Pagination

Pagination response details.

NextCursor string

PreviousCursor string

TotalCount int64

minimum0

MembershipsInvitations

Create Organization Invitation

client.Organizations.Memberships.Invitations.New(ctx, organizationID, body) (*OrganizationInvitation, error)

POST/v1/organizations/{organization_id}/memberships/invitations

List Organization Invitations

client.Organizations.Memberships.Invitations.List(ctx, organizationID) (*OrganizationInvitationList, error)

GET/v1/organizations/{organization_id}/memberships/invitations

Resend Organization Invitation

client.Organizations.Memberships.Invitations.Resend(ctx, organizationID, invitationID) (*OrganizationInvitation, error)

POST/v1/organizations/{organization_id}/memberships/invitations/{invitation_id}/resend

Revoke Organization Invitation

client.Organizations.Memberships.Invitations.Delete(ctx, organizationID, invitationID) error

DELETE/v1/organizations/{organization_id}/memberships/invitations/{invitation_id}

ModelsExpand Collapse

type OrganizationInvitation struct{…}

Organization invitation details.

ID string

Invitation ID.

CreatedAt Time

When the invitation was created.

formatdate-time

Email string

Email address the invitation was sent to.

ExpiresAt Time

When the invitation expires.

formatdate-time

InviterUserID string

ID of the user who sent the invitation, or null when the sender is not known.

OrganizationID string

Organization ID.

Role OrganizationInvitationRole

Role of the user in the organization.

One of the following:

const OrganizationInvitationRoleOwner OrganizationInvitationRole = "owner"

const OrganizationInvitationRoleAdmin OrganizationInvitationRole = "admin"

const OrganizationInvitationRoleBilling OrganizationInvitationRole = "billing"

const OrganizationInvitationRoleMember OrganizationInvitationRole = "member"

type OrganizationInvitationList struct{…}

Items []OrganizationInvitation

ID string

Invitation ID.

CreatedAt Time

When the invitation was created.

formatdate-time

Email string

Email address the invitation was sent to.

ExpiresAt Time

When the invitation expires.

formatdate-time

InviterUserID string

ID of the user who sent the invitation, or null when the sender is not known.

OrganizationID string

Organization ID.

Role OrganizationInvitationRole

Role of the user in the organization.

One of the following:

const OrganizationInvitationRoleOwner OrganizationInvitationRole = "owner"

const OrganizationInvitationRoleAdmin OrganizationInvitationRole = "admin"

const OrganizationInvitationRoleBilling OrganizationInvitationRole = "billing"

const OrganizationInvitationRoleMember OrganizationInvitationRole = "member"

Pagination Pagination

Pagination response details.

NextCursor string

PreviousCursor string

TotalCount int64

minimum0