# Albato API documentation Documentation > Documentation for Albato API documentation ## Guides - [Overview](https://docs.albato.com/docs/overview.md) - [Implementation Guide for Albato Embedded](https://docs.albato.com/docs/implementation-guide-for-albato-embedded.md): A step-by-step guide on how to embed Albato in your SaaS. - [Embedding Albato via an iFrame](https://docs.albato.com/docs/embedding-albato-via-an-iframe.md) - [How to White-Label Albato OAuth in your SaaS](https://docs.albato.com/docs/how-to-white-label-albato-oauth-in-your-saas.md): In this article, we explore how to Authenticate Your Account on 3rd Party Platforms. - [Creating a seamless integration experience with webhooks](https://docs.albato.com/docs/creating-a-seamless-integration-experience-with-webhooks.md): In this guide, we go through the process of creating a seamless integration experience with webhooks. - [How to Create a Connection via Link](https://docs.albato.com/docs/how-to-create-a-connection-via-link.md): This guide explains how to create connections using unique "one-time" links, allowing clients to provide Albato with all necessary connection data by simply following a link. - [How to Update user data in a Connection](https://docs.albato.com/docs/how-to-update-a-connection-refresh-user-data.md): This guide explains how to refresh an existing connection so Albato re-reads user data (for example, newly created custom fields) after the connection was created via link. - [General Information about Solutions](https://docs.albato.com/docs/general-information-about-solutions.md) - [Getting an API Key and Creating Users](https://docs.albato.com/docs/getting-an-api-key-and-creating-users.md): This article provides a step-by-step quick start process for working with the Albato Embedded API: obtaining a master token, creating an end-user account, using and refreshing the user token. - [Installing a Solution via API](https://docs.albato.com/docs/installing-a-solution-via-api.md): This article provides detailed information on how to perform solution installation via API. - [Changing Field Values in a Solution Installation via API](https://docs.albato.com/docs/changing-field-values-in-a-solution-installation-via-api.md): This article provides detailed information on how to change the values of automation step fields in a solution installation via API. - [Getting Solution History](https://docs.albato.com/docs/getting-solution-history.md): This article provides detailed information on how to get the bundle run log from a solution installation. - [Running Albato Triggers and Actions via API (beta)](https://docs.albato.com/docs/general-information.md): This documentation provides a step-by-step guide on how to run a partner’s API trigger or action **once** using Albato’s Universal API. ## API Reference - [User authentication](https://docs.albato.com/reference/post_user-auth.md): Obtain an authToken using the user's email and password. - [Create user](https://docs.albato.com/reference/adduser.md): Registers a new user for working with integrations. Requires the partner's master token. - [Refresh user token](https://docs.albato.com/reference/getusersessiontoken.md): Obtains a new access token for a previously created user. Requires the partner's master token. - [Get user profile](https://docs.albato.com/reference/getuserprofile.md): Returns the parameters of a previously created user. Requires the partner's master token. - [Block user plan](https://docs.albato.com/reference/blockuserplan.md): Blocks the plan of a previously created user. Requires the partner's master token. - [Delete user](https://docs.albato.com/reference/deleteuser.md): Deletes a previously created user. Requires the partner's master token. - [Assign user plan](https://docs.albato.com/reference/setuserplan.md): Assigns a plan (transaction limit) to a previously created user. Requires the partner's master token. - [Add transactions to user plan](https://docs.albato.com/reference/adduserplantransactions.md): Adds extra transactions to a user's plan. Requires the partner's master token. - [Get list of plans](https://docs.albato.com/reference/listplans.md): Returns a list of available plans for assigning to users. Requires the partner's master token. - [Create or update connection to own system](https://docs.albato.com/reference/upsertowncredential.md): Creates or updates a user's connection to your system. Requires the user's token. - [Get connection to own system](https://docs.albato.com/reference/getowncredential.md): Returns the user's connection parameters to your system. Requires the user's token. - [Get connection metadata to own system](https://docs.albato.com/reference/getowncredentialmetadata.md): Returns metadata (fields) of the connection to your system. Requires the user's token or the master token. - [Create sharing entity](https://docs.albato.com/reference/creategrantaccesssharing.md): Create a new sharing entity to generate a unique one-time token for connection creation via link - [Get list of sharing entities](https://docs.albato.com/reference/getgrantaccesssharinglist.md): Retrieve all sharing entities created by the authenticated user with pagination support - [Get sharing entity by ID](https://docs.albato.com/reference/getgrantaccesssharingbyid.md): Retrieve sharing entity details and monitor connection creation status - [Update sharing entity](https://docs.albato.com/reference/updategrantaccesssharing.md): Update an existing sharing entity to regenerate the token and reset status. This is useful when: - The link expired after 48 hours without connection creation - The link was compromised and needs to be regenerated - You need to reset sharing status for reuse - [Delete sharing entity](https://docs.albato.com/reference/deletegrantaccesssharing.md): Delete an existing sharing entity to revoke the token and prevent further use. This is useful when: - You no longer need the sharing link - You want to clean up unused or expired sharing entities - You need to revoke access for security reasons After deletion, the token becomes permanently invalid and cannot be used for connection creation. - [Update user data for a connection](https://docs.albato.com/reference/updateuserdata.md) - [Get credentials metadata](https://docs.albato.com/reference/get_credentials-partnerid-meta.md): Returns metadata and field schema for creating or editing a credential for a specific partner. - [Update credential for connection (with details)](https://docs.albato.com/reference/put_credentials-partnerid-credentialid.md): Updates an existing credential for the specified partner, including detailed field values and lists. - [Create credential for connection](https://docs.albato.com/reference/post_credentials-partnerid.md): Creates a new credential for the specified partner. The request body for this endpoint is dynamic and depends on the `partnerId`. To determine the required fields for a specific partner, first make a request to the `GET /credentials/{partnerId}/meta` endpoint. That endpoint will return the schema and fields necessary to create the credential. - [Get credential wizard details](https://docs.albato.com/reference/get_bundle-credentials-wizard.md): Returns credential wizard details for a specific trigger action. - [Get list of solutions](https://docs.albato.com/reference/get_solution-apps.md): Returns a list of all available user's solutions. Supports pagination. - [Get step structure for solution installation](https://docs.albato.com/reference/get_solution-id-credentialists.md): Retrieves the step structure for forming credentialData. - [Install solution](https://docs.albato.com/reference/post_solution-id-installation.md): Installs a solution by its identifier. Requires a valid user token. To install a solution, you must provide: - The `credentialData` object (with selected values for each step) - The `templateIds` array (IDs of templates to be installed) - The installation `title` (any string to identify the installation) - [Get list of installed solutions](https://docs.albato.com/reference/get_solution-installation-1.md): Returns a list of all solutions installed by the user. Requires a valid user token. - [Get solution installation details](https://docs.albato.com/reference/get_solution-installation-id-1.md): Returns detailed information about a solution installation, including bundles, steps, and app info. Requires a valid user token. - [Get bundle step field values](https://docs.albato.com/reference/get_bundle-data-1.md): Returns a list of bundle steps and their current field values. Requires a valid user token. - [Update field value in bundle step](https://docs.albato.com/reference/put_bundle-data-id-1.md): Allows you to change the value of a field in a specific bundle step. > **Important:** You can only change field values for paused solution installations. If the installation is active, you must pause it first. **Selecting a value from a list:** If the field supports a list of values, you must specify the value using a colon in the following format: ```json { "cf__8ad75c5a8821cc294f189181722acb56": "{%831983:C%}" } ``` - `831983` is the list identifier - `C` is the value to select from the list **Request example:** ```bash curl --location --request PUT 'https://api.albato.com/bundle/data/831984' \ --header 'Content-Type: application/json' \ --header 'Authorization: Bearer ' \ --data '{ "data": { "cf__8ad75c5a8821cc294f189181722acb56": "{%831983:C%}" } }' ``` **Request body:** - `data` (object): Object with field codes as keys and new values as values. For example, `{ "cf__8ad75c5a8821cc294f189181722acb56": "{%831983:C%}" }`. **Response example:** ```json { "success": true, "data": { "id": 831984 } } ``` - [Get bundle event list](https://docs.albato.com/reference/get_bundle-events-1.md): Returns a list of events (runs) for all or a selected bundle. Use the `expand=steps` parameter to include event steps in the response. - [Get bundle event step details](https://docs.albato.com/reference/get_bundle-events-steps-step-id-1.md): Returns detailed information about a specific step of a bundle event (run). - [Get partner list](https://docs.albato.com/reference/get_partners-info.md): Returns a list of partners. Supports filtering by title and deprecation status. - [Get partner trigger action list](https://docs.albato.com/reference/get_partners-trigger-actions-info.md): Returns a list of trigger actions for the specified partner. Supports filtering by partnerId and isAction. - [Get run schema and field descriptions](https://docs.albato.com/reference/getruninfo.md): Returns the complete schema for running a trigger/action, including: - Editable variables with types and validation rules - Custom fields (cf__ prefixed) - Data dictionaries for dropdown/select fields - RowSections for array-based fields (emails, phones, etc.) - Required vs optional field indicators - [Run synchronously](https://docs.albato.com/reference/runtriggeractionsync.md): Executes the trigger/action synchronously and returns immediate results. Use the schema from /run/info to construct proper request body. For heavy operations, consider using /run/async instead.