# getPatentFamily

**Identifier:** `lens_getPatentFamily`

**Provider:** [Lens](https://kirha.com/providers/lens.md)

Retrieve all members of a patent's simple (DOCDB) or extended (INPADOC) family, showing how an invention is protected across jurisdictions. Returns family member Lens IDs that can be used with searchPatents or getPatent.

## Run it with the CLI

```bash
kirha tools run lens_getPatentFamily \
  --input '{
    "lensId": "145-564-229-856-440"
  }'
```

`--input` takes a JSON object that matches the input schema. Pass `--input -` to read it from stdin.

## Call it over HTTP

```bash
curl https://api.kirha.com/tools/v1/execute \
  --request POST \
  --header 'Content-Type: application/json' \
  --header 'Authorization: **********' \
  --data '{
  "tool_name": "lens_getPatentFamily",
  "input": {
    "lensId": "145-564-229-856-440"
  }
}'
```

Replace the stars with an API key from https://app.kirha.com/api-keys.

## Input schema

```json
{
  "$schema": "https://json-schema.org/draft/2020-12/schema",
  "properties": {
    "familyType": {
      "default": "simple",
      "enum": [
        "simple",
        "extended"
      ],
      "type": "string"
    },
    "lensId": {
      "description": "From searchPatents or getPatent, e.g., 145-564-229-856-440",
      "type": "string"
    }
  },
  "required": [
    "lensId"
  ],
  "type": "object"
}
```

## Output schema

```json
{
  "$schema": "https://json-schema.org/draft/2020-12/schema",
  "additionalProperties": false,
  "properties": {
    "context": {
      "type": "string"
    },
    "familySize": {
      "type": "number"
    },
    "familyType": {
      "enum": [
        "simple",
        "extended"
      ],
      "type": "string"
    },
    "lensId": {
      "type": "string"
    },
    "lensIds": {
      "description": "Lens IDs of family members for composition with searchPatents, getPatent",
      "items": {
        "type": "string"
      },
      "type": "array"
    },
    "members": {
      "description": "First 300 members; lensIds lists all",
      "items": {
        "additionalProperties": false,
        "properties": {
          "docNumber": {
            "type": "string"
          },
          "jurisdiction": {
            "type": "string"
          },
          "kind": {
            "type": "string"
          },
          "lensId": {
            "type": "string"
          }
        },
        "type": "object"
      },
      "type": "array"
    }
  },
  "required": [
    "context",
    "lensId",
    "familyType",
    "members",
    "lensIds"
  ],
  "type": "object"
}
```

## Related tools

Other Lens tools that this tool refers to, or that refer to it.

- [`searchPatents`](https://kirha.com/providers/lens/searchPatents.md)
- [`getPatent`](https://kirha.com/providers/lens/getPatent.md)

-----

[All Lens tools](https://kirha.com/providers/lens.md) · [< Back to tools list](https://kirha.com/tools.md)