Skip to content
Docs

List Organization Memberships

client.Organizations.Memberships.List(ctx, organizationID, query) (*Cursor[OrganizationMembership], error)
GET/v1/organizations/{organization_id}/memberships

List all memberships for an organization

ParametersExpand Collapse
organizationID string
query MembershipListParams
Cursor param.Field[string]Optional

Pagination cursor returned by a previous request

Limit param.Field[int64]Optional

Maximum number of items to return

maximum100
minimum10
ReturnsExpand 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 OrganizationMembershipRoleMember OrganizationMembershipRole = "member"
UpdatedAt Time

When the membership was updated.

formatdate-time
UserID string

User ID.

List Organization Memberships

package main

import (
  "context"
  "fmt"

  "github.com/nirvana-labs/nirvana-go"
  "github.com/nirvana-labs/nirvana-go/option"
  "github.com/nirvana-labs/nirvana-go/organizations"
)

func main() {
  client := nirvana.NewClient(
    option.WithAPIKey("My API Key"),
  )
  page, err := client.Organizations.Memberships.List(
    context.TODO(),
    "organization_id",
    organizations.MembershipListParams{

    },
  )
  if err != nil {
    panic(err.Error())
  }
  fmt.Printf("%+v\n", page)
}
{
  "items": [
    {
      "id": "987e6543-e89b-12d3-a456-426614174000",
      "created_at": "2025-01-01T00:00:00Z",
      "organization_id": "123e4567-e89b-12d3-a456-426614174000",
      "role": "owner",
      "updated_at": "2025-01-01T00:00:00Z",
      "user_id": "user_01H8GQBX3Z"
    }
  ],
  "pagination": {
    "next_cursor": "RhwniMT4B74siYZcPF8TnCdGI1l9rpPvg",
    "previous_cursor": "ARhwnmi1hA7wEbHbMjdYQlOB_ZusP4fYvw",
    "total_count": 125
  }
}
Returns Examples
{
  "items": [
    {
      "id": "987e6543-e89b-12d3-a456-426614174000",
      "created_at": "2025-01-01T00:00:00Z",
      "organization_id": "123e4567-e89b-12d3-a456-426614174000",
      "role": "owner",
      "updated_at": "2025-01-01T00:00:00Z",
      "user_id": "user_01H8GQBX3Z"
    }
  ],
  "pagination": {
    "next_cursor": "RhwniMT4B74siYZcPF8TnCdGI1l9rpPvg",
    "previous_cursor": "ARhwnmi1hA7wEbHbMjdYQlOB_ZusP4fYvw",
    "total_count": 125
  }
}