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

# Customer Records Tool

> Let an agent read the subscriptions, contracts or other records your workspace keeps about the person it is talking to

The Customer Records tool lets an agent answer questions that depend on what you know about the customer: "When does my subscription renew?", "Which sites are on my contract?". It reads the [custom objects](https://ago.mintlify.site/features/customers.md#custom-objects) of **Customers** that belong to the person in the conversation.

**Tool type:** `ago_customer_records`

The agent first asks which kinds of records exist for this person, then reads the ones it needs, optionally with a filter such as "status is Active". It receives the record values, with choices shown by their label.

## What the agent can read

The agent reads a record only when all of the following hold:

* Agent access to customer records is turned on for your workspace. It is off by default; contact AGO to turn it on.
* The record's object type is exposed in **Customers** > **Data model** > **Access** > **Support agent access**, with a path from the type to a contact or a company.
* The record belongs to the person: it is linked to their contact, or to their company when the type is exposed per company.
* The person's identity is proven. See below.

It only receives the attributes you selected for the type. Attributes marked **Sensitive** or **Admins only**, formulas computed from them, and attributes that name a team member are never sent, and the agent cannot filter on them. The agent cannot create, change or delete records, and cannot read any other person's records, whatever the person or the conversation asks.

## Proven identity

| How the person reaches the agent | Records readable |
| - | - |
| Signed in through your app or SDK with a token whose `email_verified` claim is `true`, or an email your customer API resolved | Those of the contact with that email, when exactly one contact has it |
| A token that does not say the email is verified, even if your workspace trusts its emails for other features | None |
| A message received from WhatsApp | Those of the contact whose phone number matches, when exactly one contact has it |
| Anonymous visitor, or an email typed in the chat | None |
| Email, voice | None |

Only the message being answered counts: a WhatsApp number is proven for a message WhatsApp delivered, not for other messages of the same conversation. Email addresses with characters outside plain ASCII are not accepted as proof.

When the identity is not proven, the agent is told so and is instructed not to ask for an email or a number, since typing one would not prove anything. Make sure each contact's phone number is right before relying on WhatsApp: the phone number of a contact can only be changed by your team, an import, the API or the [HubSpot sync](https://ago.mintlify.site/data-connector/hubspot-integration.md#sync-hubspot-records-into-customers) when it maps the phone.

## Limits

| Limit | Value |
| - | - |
| Records per lookup | 20, the most recently updated first |
| Lookups per person, across conversations | 20 per minute |

Each lookup is recorded with the conversation, the contact, how their identity was proven and the records read.

## Configuration

1. Expose at least one object type in **Customers** > **Data model** > **Access** > **Support agent access**. See [Let your agents read customer records](https://ago.mintlify.site/features/customers.md#let-your-agents-read-customer-records).
2. Go to **AI Studio** > **Tools** and click **Create Tool**.
3. Set **Tool Type** to `ago_customer_records`, give the tool a name and click **Save**.
4. Open the agent in **AI Studio** > **Agents** and add the tool under **Capabilities** > **Available Tools**.

## Best practices

Tell the agent when to look records up, and what to do when it cannot:

```markdown theme={null}
## Customer records

When the user asks about their subscription, renewal date or plan,
look it up with the customer records tool before answering.
If the tool says their identity is not proven, explain that you cannot
see their account here and point them to the customer area of the app.
```

## Related

> [card] [Customers](https://ago.mintlify.site/features/customers.md#custom-objects)
>
> Define object types and choose what agents can read

> [card] [Tools Overview](https://ago.mintlify.site/features/tools.md)
>
> Create tools and assign them to agents


This documentation is built and hosted on [Mintlify](https://mintlify.com), a developer documentation platform.