# Memberships

## Get Organization Membership

`$ nirvana organizations:memberships get`

**get** `/v1/organizations/{organization_id}/memberships/{membership_id}`

Get details about an organization membership

### Parameters

- `--organization-id: string`

  Organization ID

- `--membership-id: string`

  Membership ID

### Returns

- `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 "member"`

    Role of the user in the organization.

    - `"owner"`

    - `"member"`

  - `updated_at: string`

    When the membership was updated.

  - `user_id: string`

    User ID.

### Example

```cli
nirvana organizations:memberships get \
  --api-key 'My API Key' \
  --organization-id organization_id \
  --membership-id membership_id
```

#### Response

```json
{
  "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"
}
```

## List Organization Memberships

`$ nirvana organizations:memberships list`

**get** `/v1/organizations/{organization_id}/memberships`

List all memberships for an organization

### Parameters

- `--organization-id: string`

  Organization ID

- `--cursor: optional string`

  Pagination cursor returned by a previous request

- `--limit: optional number`

  Maximum number of items to return

### Returns

- `organization_membership_list: object { items, pagination }`

  - `items: array of OrganizationMembership`

    - `id: string`

      Membership ID.

    - `created_at: string`

      When the membership was created.

    - `organization_id: string`

      Organization ID.

    - `role: "owner" or "member"`

      Role of the user in the organization.

      - `"owner"`

      - `"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`

### Example

```cli
nirvana organizations:memberships list \
  --api-key 'My API Key' \
  --organization-id organization_id
```

#### Response

```json
{
  "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
  }
}
```

## Domain Types

### Organization Membership

- `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 "member"`

    Role of the user in the organization.

    - `"owner"`

    - `"member"`

  - `updated_at: string`

    When the membership was updated.

  - `user_id: string`

    User ID.

### Organization Membership List

- `organization_membership_list: object { items, pagination }`

  - `items: array of OrganizationMembership`

    - `id: string`

      Membership ID.

    - `created_at: string`

      When the membership was created.

    - `organization_id: string`

      Organization ID.

    - `role: "owner" or "member"`

      Role of the user in the organization.

      - `"owner"`

      - `"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`