Memberships

Get Organization Membership

$ nirvana organizations:memberships get

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

List Organization Memberships

$ nirvana organizations:memberships list

GET/v1/organizations/{organization_id}/memberships

Update Organization Membership

$ nirvana organizations:memberships update

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

Delete Organization Membership

$ nirvana organizations:memberships delete

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

ModelsExpand Collapse

organization_membership: object { id, created_at, organization_id, 3 more }

Organization membership details.

id: string

Membership ID.

created_at: string

When the membership was created.

organization_id: string

Organization ID.

role: "owner" or "admin" or "billing" or "member"

Role of the user in the organization.

"owner"

"admin"

"billing"

"member"

updated_at: string

When the membership was updated.

user_id: string

User ID.

organization_membership_list: object { items, pagination }

items: array of OrganizationMembership { id, created_at, organization_id, 3 more }

id: string

Membership ID.

created_at: string

When the membership was created.

organization_id: string

Organization ID.

role: "owner" or "admin" or "billing" or "member"

Role of the user in the organization.

"owner"

"admin"

"billing"

"member"

updated_at: string

When the membership was updated.

user_id: string

User ID.

pagination: object { next_cursor, previous_cursor, total_count }

Pagination response details.

next_cursor: string

previous_cursor: string

total_count: number

MembershipsInvitations

Create Organization Invitation

$ nirvana organizations:memberships:invitations create

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

List Organization Invitations

$ nirvana organizations:memberships:invitations list

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

Resend Organization Invitation

$ nirvana organizations:memberships:invitations resend

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

Revoke Organization Invitation

$ nirvana organizations:memberships:invitations delete

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

ModelsExpand Collapse

organization_invitation: object { id, created_at, email, 4 more }

Organization invitation details.

id: string

Invitation ID.

created_at: string

When the invitation was created.

email: string

Email address the invitation was sent to.

expires_at: string

When the invitation expires.

inviter_user_id: string

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

organization_id: string

Organization ID.

role: "owner" or "admin" or "billing" or "member"

Role of the user in the organization.

"owner"

"admin"

"billing"

"member"

organization_invitation_list: object { items, pagination }

items: array of OrganizationInvitation { id, created_at, email, 4 more }

id: string

Invitation ID.

created_at: string

When the invitation was created.

email: string

Email address the invitation was sent to.

expires_at: string

When the invitation expires.

inviter_user_id: string

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

organization_id: string

Organization ID.

role: "owner" or "admin" or "billing" or "member"

Role of the user in the organization.

"owner"

"admin"

"billing"

"member"

pagination: object { next_cursor, previous_cursor, total_count }

Pagination response details.

next_cursor: string

previous_cursor: string

total_count: number