# getStudyDetails

**Identifier:** `clinicaltrials_getStudyDetails`

**Provider:** [ClinicalTrials](https://kirha.com/providers/clinicaltrials.md)

Get complete study protocol details for a specific clinical trial by NCT ID.

## Run it with the CLI

```bash
kirha tools run clinicaltrials_getStudyDetails \
  --input '{
    "nctId": "NCT00001232"
  }'
```

`--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": "clinicaltrials_getStudyDetails",
  "input": {
    "nctId": "NCT00001232"
  }
}'
```

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": {
    "country": {
      "description": "Only return sites in this country (e.g., United States). Use it to answer questions about sites in one country.",
      "type": "string"
    },
    "locationsOffset": {
      "description": "Skip this many matching sites. Use the nextLocationsOffset of a previous response to page through sites.",
      "maximum": 9007199254740991,
      "minimum": 0,
      "type": "integer"
    },
    "nctId": {
      "description": "ClinicalTrials.gov identifier (e.g., NCT00001232)",
      "type": "string"
    }
  },
  "required": [
    "nctId"
  ],
  "type": "object"
}
```

## Output schema

```json
{
  "$schema": "https://json-schema.org/draft/2020-12/schema",
  "additionalProperties": false,
  "properties": {
    "acronym": {
      "type": "string"
    },
    "briefSummary": {
      "type": "string"
    },
    "centralContacts": {
      "items": {
        "additionalProperties": false,
        "properties": {
          "email": {
            "type": "string"
          },
          "name": {
            "type": "string"
          },
          "phone": {
            "type": "string"
          },
          "role": {
            "type": "string"
          }
        },
        "required": [
          "name"
        ],
        "type": "object"
      },
      "type": "array"
    },
    "collaborators": {
      "items": {
        "type": "string"
      },
      "type": "array"
    },
    "completionDate": {
      "type": "string"
    },
    "conditions": {
      "items": {
        "type": "string"
      },
      "type": "array"
    },
    "context": {
      "type": "string"
    },
    "eligibilityCriteria": {
      "type": "string"
    },
    "interventions": {
      "items": {
        "additionalProperties": false,
        "properties": {
          "description": {
            "type": "string"
          },
          "name": {
            "type": "string"
          },
          "type": {
            "type": "string"
          }
        },
        "required": [
          "type",
          "name"
        ],
        "type": "object"
      },
      "type": "array"
    },
    "keywords": {
      "items": {
        "type": "string"
      },
      "type": "array"
    },
    "lastUpdateDate": {
      "type": "string"
    },
    "locations": {
      "description": "Sites with their contacts, filtered by country when given",
      "items": {
        "additionalProperties": false,
        "properties": {
          "city": {
            "type": "string"
          },
          "contacts": {
            "description": "Site contacts and site principal investigators (role PRINCIPAL_INVESTIGATOR)",
            "items": {
              "additionalProperties": false,
              "properties": {
                "email": {
                  "type": "string"
                },
                "name": {
                  "type": "string"
                },
                "phone": {
                  "type": "string"
                },
                "role": {
                  "type": "string"
                }
              },
              "required": [
                "name"
              ],
              "type": "object"
            },
            "type": "array"
          },
          "country": {
            "type": "string"
          },
          "facility": {
            "type": "string"
          },
          "state": {
            "type": "string"
          },
          "status": {
            "type": "string"
          }
        },
        "required": [
          "facility",
          "city",
          "country"
        ],
        "type": "object"
      },
      "type": "array"
    },
    "matchingLocations": {
      "description": "Sites matching the country filter (equals totalLocations without a filter)",
      "type": "number"
    },
    "nctId": {
      "type": "string"
    },
    "nextLocationsOffset": {
      "description": "Pass as locationsOffset to get the remaining sites; absent when all were returned",
      "type": "number"
    },
    "outcomes": {
      "additionalProperties": false,
      "properties": {
        "primary": {
          "items": {
            "additionalProperties": false,
            "properties": {
              "description": {
                "type": "string"
              },
              "measure": {
                "type": "string"
              },
              "title": {
                "type": "string"
              }
            },
            "required": [
              "title"
            ],
            "type": "object"
          },
          "type": "array"
        },
        "secondary": {
          "items": {
            "additionalProperties": false,
            "properties": {
              "description": {
                "type": "string"
              },
              "measure": {
                "type": "string"
              },
              "title": {
                "type": "string"
              }
            },
            "required": [
              "title"
            ],
            "type": "object"
          },
          "type": "array"
        },
        "totalPrimary": {
          "type": "number"
        },
        "totalSecondary": {
          "type": "number"
        }
      },
      "required": [
        "totalPrimary",
        "totalSecondary"
      ],
      "type": "object"
    },
    "overallOfficials": {
      "description": "Principal investigators and study chairs",
      "items": {
        "additionalProperties": false,
        "properties": {
          "affiliation": {
            "type": "string"
          },
          "name": {
            "type": "string"
          },
          "role": {
            "type": "string"
          }
        },
        "required": [
          "name"
        ],
        "type": "object"
      },
      "type": "array"
    },
    "phase": {
      "type": "string"
    },
    "primaryCompletionDate": {
      "type": "string"
    },
    "secondaryIds": {
      "description": "Other registry IDs, e.g., EudraCT or EU CT numbers",
      "items": {
        "additionalProperties": false,
        "properties": {
          "id": {
            "type": "string"
          },
          "type": {
            "type": "string"
          }
        },
        "required": [
          "id"
        ],
        "type": "object"
      },
      "type": "array"
    },
    "sponsor": {
      "type": "string"
    },
    "sponsorStudyId": {
      "description": "Sponsor's internal protocol number",
      "type": "string"
    },
    "startDate": {
      "type": "string"
    },
    "status": {
      "type": "string"
    },
    "studyType": {
      "type": "string"
    },
    "targetEnrollment": {
      "type": "number"
    },
    "title": {
      "type": "string"
    },
    "totalLocations": {
      "description": "All sites of the study, before any country filter",
      "type": "number"
    }
  },
  "required": [
    "context",
    "nctId",
    "title",
    "status",
    "briefSummary",
    "outcomes",
    "totalLocations",
    "matchingLocations"
  ],
  "type": "object"
}
```

## Related tools

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

- [`searchClinicalTrials`](https://kirha.com/providers/clinicaltrials/searchClinicalTrials.md)

-----

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