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

# Attio

> Add a bot to Attio using the official integration.

[Open in Hub](https://studio.botpress.cloud/home?exploreHub=1\&hubItemId=intver_01KMZACN5Z3VJK0W280ED7G4Y0)
*v1.0.3*

The official Attio integration allows your bot to interact with objects/records in your Attio workspace.

## Setup

> [!NOTE]
>
> You will need:
>
> * A [published bot](https://botpress.com/docs/get-started/quick-start.md)
> * A [Attio account](https://app.attio.com/welcome/sign-in)

**1. Install the integration in Botpress**

First, install the integration to your bot:

1. In Botpress Studio, select **Explore Hub** in the upper-right corner.
2. Search for the **Attio** integration, then select **Install Integration**.

In the **Configuration** menu, you should see one field: **Access Token**. Leave it empty for now—you'll come back to it after creating your Attio API token.

**2. Create an Attio API token**

Next, create a Attio API token:

1. [Log in to your Attio account](https://app.attio.com/welcome/sign-in).
2. Select your workspace name in the upper-left corner. Then, select **Workspace settings**.
3. From the left navigation bar, select **Developers**.
4. Select **+ Create access token**. Enter a name, then enable the following scopes:
   * **Object configuration**: Read access
   * **Records**: Read/write access
5. Select **Save changes**, then copy the token.

**3. Configure the integration in Botpress**

Now, you can finish setting up the integration in Botpress:

1. In the integration's **Access Token** field, paste your Attio API token.
2. Select **Save Configuration**.

> [!TIP]
>
> Your Attio integration is ready. You can use the integration's [Cards](#cards) to interact with your Attio objects and records..

## Cards

> [!NOTE]
>
> When adding [filters](#param-filter) to the [List Records](#list-records) Card, follow [Attio's filtering guide](https://docs.attio.com/rest-api/how-to/filtering-and-sorting) to structure your data.

{/* vale off */}

Here's a reference for all [Cards](https://botpress.com/docs/studio/concepts/cards/introduction.md) available with the integration:

### Create Record

Create a new record in an Attio object

**input** `object`

**object** `string` *required*

Object slug or UUID

**data** `object` *required*

The record data to create

**values** `array` *required*

Array of attribute slug/ID to value(s)

**array item properties**

**attribute** `string` *required*

The attribute slug or ID

**value** `string` *required*

The value to set for the attribute

**output** `object`

**data** `object` *required*

The created record

**id** `object` *required*

The record identifier

**workspace\_id** `string` *required*

The Attio workspace ID

**object\_id** `string` *required*

The Attio object ID

**created\_at** `string` *required*

RFC3339 timestamp when the record was created

**web\_url** `string` *required*

URL of the record in Attio UI

**values** `object` *required*

Map of attribute slug or ID to its value (single value or array of values)

### Get Object

Get a single Attio object by slug or ID

**input** `object`

**object** `string` *required*

Object slug or UUID

**output** `object`

**data** `object` *required*

The requested object

**id** `object`

The object identifier

**workspace\_id** `string` *required*

The Attio workspace ID

**object\_id** `string` *required*

The Attio object ID

**api\_slug** `string`

The API slug for the object

**singular\_noun** `string`

The singular form of the object name

**plural\_noun** `string`

The plural form of the object name

**created\_at** `string`

RFC3339 timestamp when the object was created

### Get Record

Get a single record by object and record ID

**input** `object`

**object** `string` *required*

Object slug or UUID

**id** `object` *required*

The record identifier

**workspace\_id** `string` *required*

The Attio workspace ID

**object\_id** `string` *required*

The Attio object ID

**record\_id** `string` *required*

Record UUID

**output** `object`

**data** `object` *required*

The fetched record data

**id** `object` *required*

The fetched identifier

**workspace\_id** `string` *required*

The Attio workspace ID

**object\_id** `string` *required*

The Attio object ID

**web\_url** `string` *required*

URL of the record in Attio UI

**values** `object` *required*

Map of attribute slug/ID to value(s)

**created\_at** `string` *required*

RFC3339 timestamp when the record was created

### List Attributes

List attributes for a given Attio object

**input** `object`

**object** `string` *required*

Object slug or UUID

**output** `object`

**data** `array` *required*

List of attributes

**array item properties**

**id** `object`

The attribute identifier object

**workspace\_id** `string` *required*

The Attio workspace ID

**object\_id** `string` *required*

The Attio object ID

**attribute\_id** `string`

The attribute identifier

**title** `string`

The title of the attribute

**description** `string | null`

The description of the attribute

**api\_slug** `string`

The API slug for the attribute

**type** `string`

The type of the attribute

**slug** `string`

The slug for the attribute

**options** `array`

The list of options for the attribute

**array item properties**

**id** `string`

The option identifier

**label** `string`

The label of the option

**name** `string`

The name of the option

**value** `string`

The value of the option

**title** `string`

The title of the option

**slug** `string`

The slug of the option

### List Objects

List Attio objects in the workspace

**input** `object`

This Card has no input fields.

**output** `object`

**data** `array` *required*

List of objects

**array item properties**

**id** `object`

The object identifier

**workspace\_id** `string` *required*

The Attio workspace ID

**object\_id** `string` *required*

The Attio object ID

**api\_slug** `string`

The API slug for the object

**singular\_noun** `string`

The singular form of the object name

**plural\_noun** `string`

The plural form of the object name

**created\_at** `string`

RFC3339 timestamp when the object was created

### List Records

List records of an Attio object with optional filters, sorts and pagination

**input** `object`

**object** `string` *required*

Object slug or UUID, e.g. 'people'

**filter** `array`

Filtering object. See Attio Shorthand Filtering guide

**array item properties**

**attribute** `string` *required*

The attribute to filter by

**value** `string` *required*

The value to filter for

**sorts** `array`

Sorting instructions. See Attio sorting guide

**array item properties**

**direction** `enum\<string\>` *required*

The sort direction

Available options: `asc`, `desc`

**attribute** `string` *required*

The attribute to sort by

**field** `string` *required*

The field to sort by

**limit** `number`

Max number of records to return (default 500)

**offset** `number`

Number of records to skip (default 0)

**output** `object`

**data** `array` *required*

List of records

**array item properties**

**id** `object` *required*

The record identifier

**workspace\_id** `string` *required*

The Attio workspace ID

**object\_id** `string` *required*

The Attio object ID

**created\_at** `string` *required*

RFC3339 timestamp when the record was created

**web\_url** `string` *required*

URL of the record in Attio UI

**values** `object` *required*

Map of attribute slug or ID to its value (single value or array of values)

### Update Record

Update an existing record by object and record ID

**input** `object`

**object** `string` *required*

Object slug or UUID

**id** `object` *required*

The record identifier

**workspace\_id** `string` *required*

The Attio workspace ID

**object\_id** `string` *required*

The Attio object ID

**record\_id** `string` *required*

Record UUID

**data** `object` *required*

The record data to update

**values** `array` *required*

Array of attribute slug/ID to value(s) to upsert

**array item properties**

**attribute** `string` *required*

The attribute slug or ID

**value** `string` *required*

The value to set for the attribute

**output** `object`

**data** `object` *required*

The updated record

**id** `object` *required*

The record identifier

**workspace\_id** `string` *required*

The Attio workspace ID

**object\_id** `string` *required*

The Attio object ID

**created\_at** `string` *required*

RFC3339 timestamp when the record was created

**web\_url** `string` *required*

URL of the record in Attio UI

**values** `object` *required*

Map of attribute slug or ID to its value (single value or array of values)

## Triggers

{/* vale off */}

Here's a reference for all [Triggers](https://botpress.com/docs/studio/concepts/triggers.md) available with the integration:

> [!TIP]
>
> You can access data returned from any of these Triggers by reading `event.payload` after the Trigger fires.

### Record Created

A new record has been created in Attio

**payload** `object`

**event\_type** `string` *required*

The type of event

**id** `object` *required*

The record identifier object

**workspace\_id** `string` *required*

The Attio workspace ID

**object\_id** `string` *required*

The Attio object ID

**record\_id** `string` *required*

The record identifier

**actor** `object` *required*

The actor who triggered the event

**type** `string` *required*

The type of actor (e.g., workspace-member)

**id** `string` *required*

The actor identifier

### Record Deleted

A record has been deleted in Attio

**payload** `object`

**event\_type** `string` *required*

The type of event

**id** `object` *required*

The record identifier object

**workspace\_id** `string` *required*

The Attio workspace ID

**object\_id** `string` *required*

The Attio object ID

**record\_id** `string` *required*

The record identifier

**actor** `object` *required*

The actor who triggered the event

**type** `string` *required*

The type of actor (e.g., workspace-member)

**id** `string` *required*

The actor identifier

### Record Updated

A record has been updated in Attio

**payload** `object`

**event\_type** `string` *required*

The type of event

**id** `object` *required*

The record identifier object

**workspace\_id** `string` *required*

The Attio workspace ID

**object\_id** `string` *required*

The Attio object ID

**record\_id** `string` *required*

The record identifier

**actor** `object` *required*

The actor who triggered the event

**type** `string` *required*

The type of actor (e.g., workspace-member)

**id** `string` *required*

The actor identifier


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