> ## Documentation Index
> Fetch the complete documentation index at: https://docs.shakesco.com/llms.txt
> Use this file to discover all available pages before exploring further.

# Get Vesting Info

> Read the full configuration of a customer's vesting grant

<span style={{display:"none"}}>For the complete documentation index, see [llms.txt](/llms.txt).</span>

Returns the configuration of a customer's vesting grant, including how much has already been claimed and whether it's still active.

### Query Parameters

<ParamField query="customer_ref" type="string" required>
  Your unique identifier for this customer
</ParamField>

### Response

<ResponseField name="total_amount" type="string">
  Total tokens in the grant
</ResponseField>

<ResponseField name="start_time" type="string">
  Unix timestamp (seconds) when the grant was created
</ResponseField>

<ResponseField name="cliff_duration" type="string">
  Configured cliff period in seconds
</ResponseField>

<ResponseField name="cliff_percent" type="number">
  Percent unlocked at the cliff
</ResponseField>

<ResponseField name="vesting_duration" type="string">
  Total vesting period in seconds
</ResponseField>

<ResponseField name="claimed" type="string">
  Tokens the customer has already claimed
</ResponseField>

<ResponseField name="active" type="boolean">
  `false` once the grant is fully claimed or cancelled
</ResponseField>

```javascript theme={null}
const res = await fetch(
  "https://tokens.shakesco.com/vesting-info?customer_ref=customer-123",
  { headers: { Authorization: `Bearer ${API_KEY}` } }
);
const grant = await res.json();
```

<ResponseExample>
  ```json 200 OK theme={null}
  {
    "total_amount": "1000.0",
    "start_time": "1715000000",
    "cliff_duration": "7776000",
    "cliff_percent": 25,
    "vesting_duration": "31536000",
    "claimed": "250.0",
    "active": true
  }
  ```
</ResponseExample>