Attio

This endpoint allows you to update the attributes of a specific status within an attribute of a target in attio. it’s used to modify status properties such as the title, celebration settings, target time in status, and archival state. this patch operation is particularly useful when you need to refine your workflow stages, adjust time-based goals, or manage the visibility of statuses in your attio workspace. the endpoint requires you to specify the target, identifier, attribute, and status in the path, and provide the updated attributes in the request body. it’s important to note that this operation only updates the specified fields and does not affect other attributes of the status that are not included in the request.

Action Parameters

Action Response

Deletes a specific webhook from the attio platform using its unique identifier. this endpoint should be used when you need to remove a webhook that is no longer required or has become obsolete. it permanently removes the webhook configuration, stopping any further notifications or data transfers associated with it. use this endpoint with caution, as the deletion process is irreversible. once a webhook is deleted, you will need to create a new one if you want to reinstate similar functionality. this operation is useful for managing and cleaning up your webhook configurations in attio, ensuring that only active and necessary webhooks remain in your system.

Action Parameters

Action Response

Retrieves a specific record from a designated object in the attio platform. this endpoint allows you to fetch detailed information about a single record by providing the object type and the record’s unique identifier. it’s useful for accessing up-to-date information about a particular entity in your attio instance, such as a specific contact, company, or any custom object you’ve defined. the endpoint returns comprehensive data about the requested record, including all fields and their current values. use this when you need to retrieve the most recent data for a known record within a specific object type in your attio database.

Action Parameters

Action Response

This endpoint updates specific attributes of an existing entry within a designated list in attio. it uses a patch operation to modify only the specified attributes, leaving others unchanged. provide the list id, entry id, and a json payload with updated attribute values in the ‘data’ object’s ‘entry values’. supports various attribute types, but doesn’t allow adding new properties. refer to attio’s docs for correct value formats.

Action Parameters

Action Response

Permanently removes a specific record from a designated object type in the attio system. this endpoint should be used when you need to delete an individual entry from your dataset, such as removing an outdated contact or an irrelevant company profile. the operation is irreversible, so it should be used with caution. once a record is deleted, it cannot be recovered through the api. this endpoint is particularly useful for data cleanup, removing duplicate entries, or complying with data retention policies. it does not provide any confirmation or return the deleted data; it simply removes the specified record if it exists.

Action Parameters

Action Response

Updates an existing entry in a specified list within the attio platform. this endpoint allows you to modify the values of attributes for a particular entry. it’s useful for keeping your relationship data up-to-date when information changes. the endpoint supports updating both single-select and multi-select attributes, as well as other attribute types defined in attio’s attribute type documentation. use this endpoint when you need to update specific information for an entry without replacing the entire entry. note that you can only update attributes that are already associated with the entry; to add new attributes, you may need to use a different endpoint.

Action Parameters

Action Response

Retrieves detailed information about a specific thread in the attio platform using its unique identifier. this endpoint allows users to fetch comprehensive data about a particular discussion or topic thread, including its content, participants, and other relevant metadata. it should be used when detailed information about a specific thread is needed, such as when displaying thread contents, updating thread information, or analyzing thread activity. the endpoint will not modify the thread data and is read-only. note that the response may include sensitive information, so proper authorization should be ensured before exposing thread details to end-users.

Action Parameters

Action Response

Retrieves a list of all members associated with a specified workspace in attio. this endpoint is crucial for user management and collaboration features, allowing you to view and manage the individuals who have access to a particular workspace. use this when you need to audit workspace access, manage team members, or gather information about the users in a specific workspace. the endpoint returns member details such as user ids, names, roles, and possibly other relevant information like email addresses or join dates. it’s important to note that this endpoint only provides a list of members and their basic details; it does not offer functionality to modify member access or roles directly. for large workspaces, the results are likely paginated, requiring multiple api calls to retrieve the full list of members.

Action Parameters

Action Response

Retrieves the values of a specific attribute for a particular record within an object in the attio platform. this endpoint is useful for accessing detailed information about a single attribute of a record, allowing you to fetch current values without retrieving the entire record. it should be used when you need to check or verify the specific attribute values of a known record. this endpoint is particularly helpful for targeted data retrieval, reducing unnecessary data transfer when only specific attribute information is needed. note that this endpoint only provides read access to the attribute values and cannot be used to modify the data.

Action Parameters

Action Response

Updates a specific select option within an attribute for a target entity in attio. this endpoint allows you to modify the title of an existing select option and change its archived status. use this when you need to rename a select option or manage its visibility within your attio workspace. the endpoint is particularly useful for maintaining up-to-date and relevant options for your attributes, ensuring that your data remains organized and reflective of your current business needs. note that archiving an option doesn’t delete it, but rather makes it inactive while preserving historical data associated with it.

Action Parameters

Action Response

Retrieves the attributes associated with a specific target and identifier in the attio crm system. this endpoint is used to fetch metadata or properties of a particular record, such as a contact, company, or any other entity type supported by attio. it allows users to access detailed information about a specific entity, including custom fields and standard attributes. the endpoint is particularly useful when you need to gather all available data about a single record for display, analysis, or integration purposes. note that the response structure and available attributes may vary depending on the target type and your attio workspace configuration.

Action Parameters

Action Response

Creates a new list in attio with specified properties and access permissions. this endpoint allows you to define a list’s name, api slug, parent object type, and set detailed access controls for workspace members. use this when you need to create a new list for organizing records (e.g., contacts, companies) with custom visibility settings. the list’s access can be set globally for all workspace members or individually for specific members, providing flexible control over data visibility and manipulation rights within your attio workspace.

Action Parameters

Action Response

Retrieves all entries (field values) for a specific record within a given object in attio. this endpoint allows you to fetch detailed information about an individual record, such as all the fields and their values for a particular contact or company. it’s useful when you need comprehensive data about a single record without retrieving the entire object collection. the endpoint returns all available fields for the record, providing a complete view of the data stored for that specific entry. use this when you need to display or process all information related to a particular record in your application.

Action Parameters

Action Response

This endpoint creates a new attribute for a specific target (object or entry) in the attio platform. it allows you to define custom fields with various data types, configurations, and behaviors. use this endpoint when you need to extend the data model of your attio workspace by adding new fields to objects or entries. the created attribute can store different types of data (e.g., text, numbers, dates) and can be configured with specific behaviors like uniqueness, multi-select capabilities, and default values. this is particularly useful for tailoring attio to your specific business needs, such as adding custom fields for industry-specific data or internal processes. note that some configurations, like default values, are not supported for all object types, and certain attribute types (e.g., ‘status’) have limitations on where they can be used.

Action Parameters

Action Response

Retrieves a list of notes from the attio platform. this endpoint allows users to access and view notes associated with their account or organization. it’s particularly useful for getting an overview of all notes, which can include information related to contacts, meetings, or any other relevant data in the relationship management context. the endpoint should be used when you need to fetch multiple notes at once, perhaps for displaying in a list view or for syncing with another system. note that this endpoint likely returns a paginated list of notes, and additional parameters for pagination might be available but are not specified in the current schema. the response will likely include basic information for each note such as its id, title, creation date, and possibly a snippet of the content, but the full note content may require a separate api call.

Action Parameters

Action Response

The updatelist endpoint allows you to modify the properties of an existing list in the attio platform. this patch operation can be used to update the list’s name, api slug, workspace-wide access level, and individual member access permissions. it’s particularly useful when you need to rename a list, change its api accessibility, or adjust its visibility and permissions within your workspace. use this endpoint when you want to make changes to an existing list without creating a new one or replacing it entirely. it provides flexibility in managing list properties, allowing you to update one or more attributes in a single api call. note that while you can update the api slug, changing it may affect existing integrations or api calls that rely on the current slug. exercise caution when modifying this field. also, be aware that this endpoint only updates the specified fields; any fields not included in the request will retain their current values.

Action Parameters

Action Response

Retrieves a list of tasks from the attio platform. this endpoint allows users to fetch task information related to their relationship management activities. it’s particularly useful for getting an overview of ongoing tasks, tracking progress, or syncing task data with other systems. the endpoint returns task details which may include task titles, descriptions, due dates, assignees, and associated contacts or deals. use this endpoint when you need to retrieve task information for display, reporting, or further processing in your application. note that this endpoint likely returns all tasks by default, and filtering or pagination might be handled through query parameters not specified in this schema.

Action Parameters

Action Response

Retrieves detailed information about a specific list in the attio relationship management platform. this endpoint allows users to fetch the properties, metadata, and potentially the contents of a single list identified by its unique identifier. it’s useful for accessing up-to-date information about a list, including its name, description, creation date, last modified date, and possibly summary statistics about its contents. this endpoint should be used when detailed information about a specific list is needed, rather than for bulk operations or creating/updating lists. it does not modify any data and is safe for frequent calls, subject to any rate limiting that may be in place.

Action Parameters

Action Response

Retrieves a specific note by its unique identifier from the attio platform. this endpoint allows users to fetch detailed information about a single note, including its content, associated contacts or entities, creation date, and any other metadata. it should be used when you need to access or display the full contents of a particular note. the endpoint is useful for viewing note details, preparing for updates, or integrating note information into other systems. it does not modify the note and cannot be used to search across multiple notes or retrieve notes by criteria other than their id.

Action Parameters

Action Response

Creates a new note in the attio platform, associating it with a specific parent object and record. this endpoint is used to add detailed information, such as meeting summaries, call notes, or any other relevant data, to existing records in the system. the note is created with a title, content in plaintext format, and is linked to a parent object and record for organizational purposes. while it allows for backdating notes for historical records, it’s important to note that the content is limited to plaintext format only, without support for rich text formatting or special features like @mentions or links. use this endpoint when you need to programmatically add structured notes to your attio records, enhancing the depth of information in your relationship management processes.

Action Parameters

Action Response

Creates a new comment in the attio platform. this endpoint allows you to add comments to records, list entries, or reply to existing comment threads. it supports plaintext comments with the ability to mention workspace members. use this when you need to add notes, feedback, or engage in discussions within the attio workspace. the endpoint is versatile, handling both top-level comments and threaded replies, but requires careful specification of the comment’s context (record, list entry, or thread). note that rich text formatting is not supported, and comments can be backdated within certain limits for data migration purposes.

Action Parameters

Action Response

Creates a new entry in a specified list within the attio platform, linking it to a parent record. this endpoint allows you to add a record to a list while simultaneously assigning attribute values to the new list entry. it’s particularly useful for creating structured relationships between records and lists, enabling complex data organization within attio. the endpoint should be used when you need to associate an existing record with a list and provide additional context through custom attributes. it’s important to note that this operation requires an existing parent record and knowledge of the list’s attribute structure.

Action Parameters

Action Response

Retrieves a collection of lists from the attio platform. this endpoint allows users to fetch information about all available lists within their attio workspace. it’s particularly useful for getting an overview of the organizational structure and data categorization within the platform. the endpoint should be used when you need to retrieve a comprehensive list of all available lists, their names, and potentially other metadata associated with each list. it does not provide the actual contents of the lists, but rather serves as a directory of available lists. this endpoint is ideal for scenarios such as populating dropdown menus for list selection, auditing the organizational structure, or as a first step in more complex workflows involving list management.

Action Parameters

Action Response

Retrieves information about a specific object type from the attio relationship management platform. this endpoint allows you to fetch details and structure of various data entities within your attio instance, such as contacts, companies, or custom object types. use this endpoint when you need to understand the properties and structure of a particular object type in your attio setup. it’s especially useful for discovering available fields, relationships, or metadata associated with different object types. note that this endpoint retrieves the object type definition, not the actual data records of that type.

Action Parameters

Action Response

Creates a new option for a specific attribute of a target entity in attio. this endpoint allows you to add selectable values to attributes, enhancing the customization and flexibility of your data model. use this when you need to expand the list of possible values for a particular attribute of a person, company, or entry. the new option will be available for selection when updating or filtering entities based on this attribute. note that this endpoint only creates the option; it does not automatically assign it to any existing entities. ensure that the attribute is set to “selectable” before attempting to create options for it.

Action Parameters

Action Response

Retrieves a specific entry from a designated list in the attio platform using the entry’s unique identifier. this endpoint allows you to fetch detailed information about a single entry, including all its associated data fields and metadata. it’s particularly useful when you need to access or display the complete information of a specific contact, company, or any other entity type stored in an attio list. the endpoint should be used when you have both the list identifier and the entry’s unique id, and you require the most up-to-date information for that entry. it does not provide bulk retrieval capabilities or list-wide operations; for those, you would need to use separate list-focused endpoints.

Action Parameters

Action Response

Creates a new record for a specific object in attio. this endpoint allows you to add a new entry to an object (e.g., person, company, user) with custom attribute values. it’s used when you need to create a new record with specific attribute data in your attio workspace. the endpoint supports various attribute types, including single-select and multi-select options. ensure you provide valid attribute identifiers and corresponding values according to attio’s attribute type specifications. this endpoint is essential for programmatically adding new data to your attio objects.

Action Parameters

Action Response

Retrieves the available options for a specific attribute of a target entity in attio. this endpoint is used to fetch the predefined set of selectable values for a given attribute, which can be used for populating dropdown menus, validating input, or understanding the possible values for an entity’s attribute. it’s particularly useful when working with custom fields or attributes that have a finite set of allowed values. the endpoint doesn’t modify any data and is safe for frequent calls, making it ideal for dynamically updating user interfaces or validating data before submission. note that the response will only include active options; any archived or deleted options will not be returned.

Action Parameters

Action Response

Retrieves detailed information about a specific webhook in the attio system. this endpoint allows you to fetch the current configuration, status, and other relevant details of a webhook identified by its unique id. use this when you need to review or verify the settings of an existing webhook, such as its target url, the events it’s subscribed to, or its activation status. this tool is particularly useful for troubleshooting webhook-related issues or auditing your webhook configurations. it provides a snapshot of the webhook’s current state but does not modify any settings.

Action Parameters

Action Response

The querylistentries endpoint enables searching, filtering, sorting, and paginating entries within a specific attio list. it’s ideal for retrieving customized data subsets, supporting complex queries and efficient handling of large datasets. use it for tailored data retrieval, report generation, or external system integrations. while powerful, it focuses on data retrieval and organization, not data aggregation or computation.

Action Parameters

Action Response

Retrieves detailed information about a specific task within the attio relationship management platform. this endpoint allows users to fetch comprehensive data about a single task, including its current status, associated contacts, due dates, and other relevant metadata. it should be used when detailed information about a particular task is needed, such as for displaying task details in a user interface or for further processing in a workflow. the endpoint does not modify the task; it only provides read-only access to the task’s current state. note that this endpoint is part of the v2 api, which may have different features or response formats compared to earlier versions.

Action Parameters

Action Response

Creates a new webhook subscription in attio to receive notifications about specific events. this endpoint allows you to set up automated notifications for various actions within the attio platform, such as comment creation, list updates, or task deletions. use this when you want to integrate attio with external systems or automate workflows based on attio events. the webhook can be configured with multiple event subscriptions and optional filters to precisely control which events trigger notifications. note that the webhook will only receive events that occur after its creation, and there may be a slight delay between an event occurring and the webhook being triggered.

Action Parameters

Action Response

Deletes a specific entry from a designated list in the attio system. this endpoint is used to permanently remove an individual item or task from a collection, helping to manage and organize data within attio. it should be used when you need to eliminate outdated, irrelevant, or erroneous entries from a list. the operation is irreversible, so caution should be exercised when invoking this endpoint. this tool is particularly useful for maintaining the accuracy and relevance of list contents in attio, supporting efficient relationship management and team collaboration.

Action Parameters

Action Response

Retrieves the value of a specific attribute for a given entity in the attio platform. this endpoint allows you to fetch individual attribute values, providing granular access to entity data. it should be used when you need to access a particular piece of information about an entity without retrieving its entire profile. the endpoint is particularly useful for real-time data retrieval and verification of specific attributes. note that this endpoint only returns the value of a single attribute; to retrieve multiple attributes or full entity profiles, you may need to use a different endpoint or make multiple calls.

Action Parameters

Action Response

Retrieves a list of all configured webhooks for the authenticated user or organization in the attio platform. this endpoint allows users to view and manage their existing webhook integrations, which are used for real-time event notifications from attio to external applications. it’s particularly useful for reviewing current automation setups, troubleshooting integration issues, or planning new automated workflows. the response typically includes details such as webhook urls, associated events, and unique identifiers for each webhook. this endpoint should be used when setting up or managing integrations between attio and other systems, or when auditing existing automation processes. note that while this endpoint provides information about configured webhooks, it does not trigger or test them directly.

Action Parameters

Action Response

Updates a specific record within an object in the attio platform. this endpoint allows you to modify the values of one or more attributes for a given record. it’s particularly useful for updating contact information, changing status fields, or modifying any custom attributes associated with the record. the endpoint supports both single-select and multi-select attributes, allowing for flexible updates to various data types. when using this endpoint, ensure you have the correct object identifier and record id, and format the update data according to attio’s attribute type specifications.

Action Parameters

Action Response

Creates a new task in the attio platform with specified details such as content, deadline, completion status, linked records, and assignees. this endpoint should be used when you need to programmatically add tasks to your attio workspace, allowing for integration with other systems or automated task creation based on certain triggers. it’s particularly useful for bulk task creation or when tasks need to be created as part of a larger workflow. the endpoint provides flexibility in linking tasks to existing records and assigning them to workspace members, enhancing the contextual relevance of tasks within your attio ecosystem. however, it’s important to note that rich text formatting and @references within task content are not supported via the api, limiting the formatting options for task descriptions.

Action Parameters

Action Response

Deletes a specific note from the attio system using its unique identifier. this endpoint should be used when you need to permanently remove a note from the relationship management platform. it’s particularly useful for cleaning up outdated or irrelevant information, maintaining data accuracy, or complying with data retention policies. be cautious when using this endpoint, as the deletion is likely irreversible. the operation does not return the deleted note’s content, so ensure you have a backup if needed before deletion. this endpoint is essential for managing the lifecycle of notes within attio’s relationship management framework.

Action Parameters

Action Response

Creates or updates a status for a specific attribute of a target in the attio platform. this endpoint allows you to define new statuses or modify existing ones, enabling better organization and tracking of items within your workflow. use this when you need to add a new stage to your process or adjust the properties of an existing status. the endpoint is particularly useful for customizing workflow stages, setting celebration triggers for important milestones, and defining target durations for each status to improve process efficiency. note that this endpoint operates on a specific attribute of a target, so you must have the correct target, identifier, and attribute information to use it effectively.

Action Parameters

Action Response

Retrieves the values of a specific attribute for a particular entry within a list in attio. this endpoint is used to access detailed information about an entry’s attributes, allowing for granular data retrieval. it’s particularly useful when you need to fetch specific attribute data without retrieving the entire entry information. the endpoint requires the list identifier, entry id, and attribute identifier to pinpoint the exact data you’re seeking. it’s important to note that this endpoint only retrieves data and doesn’t modify any information in your attio account.

Action Parameters

Action Response

The queryrecords endpoint allows you to search and retrieve records from a specific object in attio using advanced filtering, sorting, and pagination options. this powerful querying tool is ideal for extracting precise subsets of data from your attio workspace, enabling efficient data retrieval and analysis. use this endpoint when you need to fetch records based on specific criteria, sort results in a particular order, or implement paginated data fetching. the endpoint supports complex filtering logic and multi-level sorting, making it suitable for a wide range of data querying needs. however, note that the maximum number of results per query is limited to 500 by default, so for larger datasets, you’ll need to implement pagination using the limit and offset parameters.

Action Parameters

Action Response

Retrieves a specific comment from the attio system using its unique identifier. this endpoint allows users to fetch detailed information about a single comment, including its content, author, creation date, and any associated metadata. it should be used when you need to access or display the full details of a particular comment, such as when viewing comment history or responding to a specific comment. the endpoint will not return information about other comments or modify the comment in any way. note that the availability of comment data may depend on the user’s permissions within the attio system.

Action Parameters

Action Response

Deletes a specific task from the attio platform using its unique identifier. this endpoint should be used when a task needs to be permanently removed from the system, such as when it’s no longer relevant or was created in error. the deletion is irreversible, so use with caution. this operation is useful for maintaining a clean and up-to-date task list in workflows and relationship management processes. the endpoint doesn’t return the deleted task’s data, so ensure you have any necessary information before deletion.

Action Parameters

Action Response

Retrieves a collection of objects from the attio platform. this endpoint allows users to fetch data objects without modifying them, providing a comprehensive view of the available objects in the system. it should be used when you need to list or browse through the objects in your attio workspace, such as contacts, companies, or custom object types. the endpoint returns all accessible objects by default, which may include a large amount of data. consider using appropriate query parameters (if supported) to filter or limit the results for more efficient data retrieval. note that while the schema doesn’t specify parameters, common restful practices suggest that pagination, filtering, or sorting options might be available through query parameters.

Action Parameters

Action Response

Deletes a specific comment from the attio system using its unique identifier. this endpoint should be used when you need to permanently remove a comment from your attio workspace, such as when the comment is no longer relevant or contains incorrect information. the deletion is irreversible, so use this endpoint with caution. it’s particularly useful for maintaining data cleanliness and complying with data retention policies. note that this endpoint only deletes the comment itself and does not affect any related records or relationships in the attio system.

Action Parameters

Action Response

Retrieves a list of threads from the attio platform. this endpoint allows users to fetch all available threads, which likely represent conversations or discussions related to various records, lists, notes, or tasks within the attio crm system. it’s useful for getting an overview of ongoing communications or for syncing thread data with external systems. the endpoint returns a collection of thread objects, though the exact structure of these objects is not specified in the schema. this tool should be used when you need to access or review multiple threads at once, but it may not provide detailed content of individual messages within the threads. note that the lack of query parameters might mean that all threads are returned, potentially requiring client-side filtering for specific use cases.

Action Parameters

Action Response

The updatewebhook endpoint allows you to modify the configuration of an existing webhook in the attio system. this endpoint is used to update the target url where webhook events are sent, as well as to add, remove, or modify event subscriptions and their associated filters. it’s particularly useful when you need to change the destination of webhook notifications or adjust which events trigger the webhook. the endpoint provides granular control over event filtering, enabling you to set up complex conditions for when notifications should be sent. note that this endpoint updates the entire webhook configuration, so you should include all desired subscriptions in the request, even if you’re only changing some of them.

Action Parameters

Action Response

The updateattribute endpoint allows you to modify the properties of an existing attribute within a specific object in attio. this powerful tool enables fine-tuning of your data model by adjusting attribute characteristics such as its title, description, api slug, required/unique flags, default values, and type-specific configurations. it’s particularly useful when you need to evolve your data structure, improve data quality, or adjust how information is captured and displayed in attio’s ui. the endpoint supports a wide range of attribute types, including simple fields like text and numbers, as well as more complex types like record references and currencies. when using this endpoint, be cautious as changes may affect existing data and integrations. it’s recommended to thoroughly test any attribute modifications in a non-production environment before applying them to your live workspace.

Action Parameters

Action Response

Retrieves the profile information for the currently authenticated user. this endpoint allows you to fetch details about the user who is making the api request, such as their name, email, account settings, and other relevant profile data. it should be used when you need to access or display the current user’s information within your application. the endpoint does not require any additional parameters as it relies on the authentication context to identify the user. note that this endpoint will only return data for the authenticated user and cannot be used to retrieve information about other users.

Action Parameters

Action Response

Retrieves detailed information about a specific member within an attio workspace. this endpoint allows you to fetch comprehensive data about an individual user’s profile, permissions, and role within the workspace context. use this when you need to access or verify a particular member’s details, such as during user management tasks, permission audits, or when displaying member information in your application. the endpoint provides a snapshot of the member’s current status and configuration within the workspace but does not include historical data or changes to their profile over time. it’s particularly useful for administrators and team leads who need to manage workspace memberships and understand individual user setups.

Action Parameters

Action Response

Updates records for a specific object in attio by modifying one or more attributes. this endpoint allows for bulk updates of multiple attributes across one or more records within the specified object. it’s particularly useful for synchronizing data from external sources or updating multiple fields of a record simultaneously. the endpoint accepts a flexible structure that can handle various attribute types, including single-select and multi-select options. when using this endpoint, ensure that you have the correct object identifier and use the appropriate api slug or attribute id for each attribute you want to update. note that this endpoint performs an upsert operation, meaning it will create new records if they don’t exist or update existing ones based on the provided data.

Action Parameters

Action Response

Adds a new entry to a specified list in attio. this endpoint allows you to create a list entry by associating an existing record (the parent record) with a set of attribute values specific to the list. it’s particularly useful for categorizing or organizing existing records within custom lists, enabling better relationship management and data organization. the endpoint requires you to provide the parent record’s id, the object it belongs to, and the values for the list entry’s attributes. use this when you need to add a record to a list with additional, list-specific information. note that this endpoint doesn’t create new records in attio; it only creates list entries for existing records.

Action Parameters

Action Response

Retrieves the current statuses of a specific attribute for a given entity in the attio platform. this endpoint is used to check the state or condition of a particular attribute, which is crucial for tracking changes, managing workflows, or understanding the current state of an entity’s data point. it should be used when you need to get up-to-date status information for a specific attribute of a contact, company, or other supported entity types in attio. the endpoint does not modify any data and is intended for read-only operations. it’s particularly useful for monitoring the progress of workflows, verifying the current state of attributes, or gathering information for reporting purposes.

Action Parameters

Action Response

Creates a new custom object type in the attio platform. this endpoint allows you to define the basic properties of a new object, including its api slug for future api calls and its singular and plural names for display purposes. use this when you need to establish a new category of data in your attio workspace, such as projects, products, or any other entity type specific to your business. the created object type can then be used to manage relationships and data within attio. note that this endpoint only defines the object type; you’ll need separate api calls to add actual data entries for this object type.

Action Parameters

Action Response

The update task endpoint allows you to modify an existing task in the attio system. it provides the ability to update various properties of a task, including its deadline, completion status, linked records, and assignees. this endpoint is particularly useful for managing task progress, reassigning responsibilities, or adjusting task details as project requirements evolve. the flexibility in referencing linked records and assignees makes it versatile for different use cases. however, it’s important to note that creating record links within task content text is not possible via the api at present.

Action Parameters

Action Response

This endpoint allows you to update the metadata of an existing object in attio. it is used to modify how an object is referenced and accessed within the attio platform, including its api slug, singular name, and plural name. this operation is particularly useful when you need to refine your data model or improve the clarity of your object naming conventions. the update affects how the object is accessed via the api and how it’s displayed in the attio user interface. be cautious when updating the api slug, as it will change how the object is referenced in api calls, potentially affecting existing integrations.

Action Parameters

Action Response