Getting Started
1
Create or Select a Project
Set up a new project or select an existing one. See Organizations & Projects.
2
Configure the Connector
Enable the connector and create a Connector Profile in your project. See Setup Connector Profile.

API Key · Connector Profile
Uses an API key and secret created by an Addepar user. Actions run with the tool and data permissions of that user.
OAuth 2.0 · Connector Profile
Requires an OAuth client issued by Addepar, as there is no self-serve app registration. Access is limited to the scopes…
3
Link an Account
Link an account from the dashboard (or via StackOne Hub).See the guide for the authentication type chosen in the Connector Profile:

API Key · Link Account
OAuth 2.0 · Link Account
4
Use Actions
Connect an AI platform to the linked account’s actions. See AI Platforms.Other ways to call actions are listed in Protocols & SDKs.
Actions
|
No auth methods found
|
No scopes found
269 actions
Action
Description
Required scopes
List Allocation Models
Retrieve all allocation models that the user has permission to view.
Get Allocation Model
Retrieve a specific allocation model by its ID.
Create Allocation Model
Create a new allocation model with the specified attributes.
Update Allocation Model
Update an existing allocation model.
Delete Allocation Model
Will delete an existing allocation model.
List Allocation Templates
Retrieve all allocation templates that the user has permission to view.
Get Allocation Template
Retrieve a specific allocation template by its ID.
Create Allocation Template
Create a new allocation template with the specified attributes.
Replace Allocation Template
Completely replace an existing allocation template with the provided data.
Update Allocation Template
Update an existing allocation template.
Delete Allocation Template
Delete an existing allocation template.
Query Audit Trail
Audit logs track changes to attribute values, transactions, reports, and user roles and permissions.
Get Audit Trail Record
Retrieves details about a specific user action.
List Benchmark Associations Strategies
Returns a paginated list of all active benchmark associations strategies.
Get Benchmark Associations Strategy
Returns a benchmark associations strategy with the given ID.
Create Benchmark Associations Strategy
Adds a new benchmark associations strategy to your firm.
Update Benchmark Associations Strategy
Modifies an existing benchmark associations strategy.
Delete Benchmark Associations Strategy
Deletes an existing benchmark associations strategy if it exists.
List Benchmark Compositions
Returns a paginated list of all active benchmark compositions.
Get Benchmark Composition
Returns a benchmark composition with the given ID.
Update Benchmark Composition
Modifies the underlying composition of an existing blended benchmark.
List Benchmarks
Returns a paginated list of all active benchmarks.
Get Benchmark
Returns a benchmark with the given ID.
Create Benchmark
Adds a new benchmark to your firm.
Update Benchmark
Modifies an existing benchmark.
Delete Benchmark
Deletes a user-created benchmark if it exists.
Get Imported Benchmark Data
Returns all the daily returns for an imported benchmark with the given ID.
Update Imported Benchmark Data
Add new daily returns to an existing imported benchmark.
List Billable Portfolios
Get multiple billable portfolio setups.
Get Billable Portfolio
Get a single billable portfolio setup by it’s id.
Create Billable Portfolio
Set up a group or entity for billing with a specified fee schedule.
Bulk Archive Billable Portfolios
Archive multiple billable portfolios when you no longer want to bill on them.
Bulk Update Billable Portfolio Fee Schedules
Update multiple billable portfolios’ fee schedules to different ones.
Update Billable Portfolio Fee Schedules
Update a billable portfolio’s fee schedule to a different one.
Archive Billable Portfolio
Archive a billable portfolio when you no longer want to bill on it.
List Fee Schedule Fee Relationships
Retrieves the fee relationships by fee schedule ID.
List Fee Schedule Fees
Retrieves fees associated to a fee schedule by fee schedule ID.
List Fee Schedules
Retrieves all fee schedules.
Get Fee Schedule
Retrieves a fee schedule by ID.
Create Fee Schedules
Creates all fee schedules passed in the request body as a list.
Add Fee Schedule Fees
Associates the fees with the IDs specified in the request body to the fee schedule with the specified ID in the URL.
Replace Fee Schedule
Edits a fee schedule.
Replace Fee Schedule Fees
Replaces the entire list of fees associated with a fee schedule.
Replace Fee Schedules
Edits a list of fee schedules.
Delete Fee Schedule
Deletes a fee schedule.
Delete Fee Schedules
Deletes a list of fee schedules.
Remove Fee Schedule Fees
Removes all associations with fees for the fee schedule.
List Fee Fee Schedules
Retrieves fee schedules that have the fee with the ID.
List Fee Schedule Relationships
Retrieves the fee schedule relationships by fee ID.
List Fees
Retrieves all fees.
Get Fee
Retrieves a fee by its ID.
Create Fees
Creates all fees passed in the request body as a list.
Replace Fee
Edits a fee.
Replace Fees
Edits a list of fees.
Delete Fee
Deletes a fee.
Delete Fees
Deletes a list of fees.
Publish Files To Portal
Requests to publish a file to the Client Portal.
List Contact Entity Affiliations
Retrieves a list of IDs for the entities or groups the contact has been affiliated with.
List Contact Group Affiliations
Retrieves a list of IDs for the entities or groups the contact has been affiliated with.
List Contacts
Retrieves details for all contacts.
Get Contact
Retrieves details for a specific contact.
Get Contact Default View Set
Retrieves the ID of the default view set assigned to the contact.
Get Contact Team
Retrieves the ID of the contact’s team.
Create Contact
Creates a new contact.
Add Contact Entity Affiliations
Affiliates entities or groups with a contact.
Add Contact Group Affiliations
Affiliates entities or groups with a contact.
Set Contact Default View Set
Assigns a view set as the default for a contact.
Replace Contact Entity Affiliations
Replaces a contacts entity or group affiliations with the given entities or groups.
Replace Contact Group Affiliations
Replaces a contacts entity or group affiliations with the given entities or groups.
Replace Contact Team
Replaces a contact’s team.
Update Contact
Updates a contact with the specified details.
Disable Contact SAML
Disable a contact’s SAML settings to prevent a contact from using single sign-on (SSO).
Enable Contact SAML
Enable a contact’s SAML settings to require that contact to use single sign-on (SSO).
Make Contact Two Factor Authentication Optional
Makes two-factor authentication (2FA) optional for a contact, exempting them from the firm’s 2FA Client Portal login req…
Invite Contact To Portal
Send or resend a Client Portal invite to a contact’s login email address.
Require Contact Two Factor Authentication
Require an exempted contact to follow your firm’s 2FA Client Portal login requirement.
Restore Contact Portal Access
Allow a client to once again sign into the Client Portal.
Revoke Contact Portal Access
Stop a client from being able to sign in to the Client Portal.
Delete Contact
Delete a specific contact.
Remove Contact Default View Set
Removes the default view set from a contact.
Remove Contact Entity Affiliations
Removes entities or groups from a contact’s affiliations.
Remove Contact Group Affiliations
Removes entities or groups from a contact’s affiliations.
Remove Contact Team
Removes the team from a contact.
List View Sets
Retrieves details for all view sets.
Get View Set
Retrieves details for a specific view set.
List Constituent Attributes
Retrieves all constituent attributes you have permission to access.
Get Constituent Attribute
Retrieves a specific attribute on a specific constituent.
Create Constituent Attribute
Adds an attribute value to a constituent, and returns the newly-added value.
Update Constituent Attribute
Updates the value of a constituent’s specified attribute.
Update Constituent Attributes
Updates the values of multiple constituent attributes.
Delete Constituent Attribute
Removes an attribute value from a constituent.
Delete Constituent Attributes
Removes all attribute values associated with the provided ASM ID.
List Entities
Retrieves the full list of all entities you have permission to access, as well as all attributes for each entity.
Get Entity
Retrieves all attributes for a specific entity.
Create Entity
Adds a new entity to your firm.
Update Entities
Adds, modifies, or deletes attributes of existing entities.
Update Entity
Adds, modifies, or deletes the attributes or custom attributes of an existing entity.
Delete Entities
Deletes multiple existing entities from your firm.
Delete Entity
Deletes an existing entity from your firm.
List Estimated Returns
Returns estimated returns filtered by one or more entity IDs.
Get Estimated Return
Returns a single estimated return by its composite ID.
Upsert Estimated Returns
Creates or updates estimated returns using upsert semantics.
Update Estimated Return
Updates the return value of an existing estimated return.
Delete Entity Estimated Returns
Deletes all estimated returns for a specific entity.
Delete Estimated Return
Deletes a single estimated return.
List External ID Types
Returns a list of all External ID Types.
Get External ID Type
Returns an External ID Type corresponding to the given ID.
Create External ID Type
Adds a new External ID Type to your firm.
Update External ID Type
Modifies an existing External ID Type.
Delete External ID Type
Deletes an existing External ID Type from your firm.
List Entity Prices
Returns an entity’s historical prices.
Upsert Entity Prices
Creates or updates historical prices for a given entity.
Delete Entity Price
Deletes an entity’s historical price on a specific date.
List Entity Types
Returns a list of all model types.
Get Entity Type
Returns details about a specified model type.
Update Entity Types
Updates the model type for select entities.
List Archived Files
Retrieves a list of all archived (deleted) files and/or folders, as well as information about when each was created, the…
Get Archived File
Retrieves an archived (deleted) file, as well as information about when it was created, the type of content it holds, it…
Download Archived File
Retrieves the raw contents of an archived file.
List File Associated Entities
Retrieves the full object of entities associated with the file.
List File Associated Groups
Retrieves the full object of groups associated with the file.
List Files
Retrieves a list of all files and/or folders you have permission to access, as well as details about when each was creat…
Get File
Retrieves details for a specific file or folder, such as when it was created, the type of content it holds, its name and…
Download File
Retrieves the raw contents of a specific file.
Create File
Adds a new file to your firm.
Add File Associated Entities
Adds to the list of entities associated to the file.
Add File Associated Groups
Adds to the list of groups associated to the file.
Replace File Associated Entities
Replaces all entities currently associated with different entities.
Replace File Associated Groups
Replaces all groups currently associated with different groups.
Update File
Updates the attributes and relationships for a specific file.
Delete File
Archives a file available in Addepar or a folder and everything in it.
Remove File Associated Entities
Removes the list of entities specified from the file associations.
Remove File Associated Groups
Removes the list of groups specified from the file associations.
List Group Types
Retrieve all group types for the firm.
Get Group Type
Retrieve a group type using a group type key (same as ID).
Create Group Type
Create a new group type for your firm.
Update Group Type
Change an existing group type’s display name using the group type key (same as ID).
Delete Group Type
Delete the group type using the group type key (same as ID).
List Group Child Groups
Retrieve a group’s child groups.
List Group Member Relationships
Returns the resource identifiers (type and id) of a group’s members, without member details.
List Group Members
Returns the full entity records (member details) of a group’s members.
List Groups
Retrieves all groups you have access to.
Query Groups
For a refined list of results, you can retrieve only groups with a specific display name, group type or external ID.
Get Group
Retrieves a specific group based on its ID.
Create Group
Adds a new group to your firm.
Add Group Child Groups
Adds a new child group to an existing group.
Add Group Members
Adds existing entities as members to a group.
Replace Group Child Groups
Replaces all the existing group members with new ones.
Replace Group Members
Replaces all the existing group members with new ones.
Update Group
Adds, modifies, or deletes the attributes of an existing group.
Update Groups
Adds, modifies, or deletes attributes of existing groups.
Delete Group
Deletes a group from your firm.
Delete Groups
Deletes multiple existing groups from your firm.
Remove Group Members
Removes members of a group.
Get Import
Check an import’s status by its ID.
Get Import Results
See information about an import’s results with digests, warnings, and errors.
Create Import
Imports data for one import type.
Delete Import Data
Deletes data for one import type.
List Arguments
Retrieves all attribute arguments supported by the Portfolio Query API.
Get Argument
Retrieves the attribute argument with the given ID.
List Attribute Argument Relationships
Retrieves the list of argument ids associated with the given attribute ID.
List Attribute Arguments
Retrieves the list of arguments associated with the given attribute ID.
List Attributes
Retrieves all attributes available to the user.
Query Attributes
Retrieves all attributes with matching attribute keys.
Get Attribute
Retrieves the attribute with the given ID.
Get Composite Security Constituent
Returns a constituent’s weight data from within a composite security.
Import Composite Security Constituents
Adds new constituent weight data to a composite security on a specific date.
Delete Composite Security Constituents
Removes all constituent weight data from a composite security on a specific date.
List Jobs
Retrieves the status and parameters of all jobs.
Get Job
Retrieves the status and parameters for a specific job.
Download Job Results
Returns the results of the given job.
Create Batched Job
Configure portfolio view or query requests in batch mode for faster results.
Create Portfolio Query Job
Creates an asynchronous job to extract portfolio data with a query.
Create Portfolio View Job
Creates an asynchronous job to extract portfolio data for a saved view in Addepar.
Cancel Job
Cancel a job that is has yet to start, is running, or already completed.
List Portfolio Views
Get a complete list of views for portfolios you have access to.
Query Portfolio
Returns portfolio data based on the given query parameters.
Get Portfolio View
Returns a complete request body to quickly query on a portfolio view.
Get Portfolio View Results
Returns portfolio data based on the analysis view, portfolio, and time period.
List Positions
Returns details for all positions, including inception information and relationships.
Get Position
Returns details for the specified position, including inception information and relationships.
Get Position Owned
Returns the owned entity.
Get Position Owned Relationship
Returns the relationship of the owned entity.
Get Position Owner
Returns the owner entity.
Get Position Owner Relationship
Returns the relationship of the owner entity.
Create Position
Creates a new open position.
Update Position
Updates the specified position.
Update Positions
Updates the specified open positions.
Delete Position
Removes a specified position.
Delete Positions
Removes the specified positions.
List Generated Reports
Retrieves all generated reports that a user is authenticated to view, sorted in reverse chronological order of completio…
Get Generated Report
Retrieves a generated report by its report generation job ID.
Get Generated Report Creator
Retrieves all information related to the user who generated the reports for the job id.
Get Generated Report Zipped File
Retrieves all information related to the zipped file generated for the job ID.
Download Generated Report Zipped File
Returns a binary zipped file.
Run Report
Runs a report, generating a PDF for each associated and specified portfolio.
List Reports
Obtain a list of reports to use as a starting point for other API workflows.
Get Snapshot
Returns a snapshot or valuation with the given ID.
Get Snapshot Owned
Returns the owned entity of the snapshot or valuation.
Get Snapshot Owned Relationship
Returns the relationship of the owned entity.
Get Snapshot Owner
Returns the owner entity of the snapshot or valuation.
Get Snapshot Owner Relationship
Returns the relationship of the owner entity.
Get Snapshot Position
Returns the snapshot or valuation’s position with the given ID.
Get Snapshot Position Relationship
Returns the snapshot or valuation’s position relationship.
Create Snapshot
Adds a new snapshot or valuation to your firm.
Update Snapshot
Modifies an existing snapshot or valuation.
Update Snapshots
Modifies existing snapshots or valuations.
Delete Snapshot
Deletes an existing snapshot or valuation if it exists.
Delete Snapshots
Deletes existing snapshots or valuations.
List Transaction Jobs
Retrieves the status and parameters of all jobs.
Get Transaction Job
Retrieves the status and parameters for a specific job.
Get Transaction Job Creator
Retrieves the user who created the job.
Get Transaction Job Creator Relationship
Retrieves the relationship of the job creator.
Download Transaction Job Results
Returns the results of the given job.
Create Transaction Job
Creates an asynchronous job to extract transaction data for a saved transaction view in Addepar.
Cancel Transaction Job
Cancel a job that is has yet to start, is running, or already completed.
List Transaction Files
Retrieves visible document metadata attached to a transaction.
Query Transactions
Returns transaction data based on the given query parameters.
Get Transaction
Retrieves a single transaction by ID, including attributes, calculated values, relationship links, and self links.
Get Transaction Cash Position
Inspect individual related resources or retrieve their relationship linkage identifiers directly using dedicated sub-res…
Get Transaction Cash Position Relationship
Inspect individual related resources or retrieve their relationship linkage identifiers directly using dedicated sub-res…
Get Transaction New Owned
Inspect individual related resources or retrieve their relationship linkage identifiers directly using dedicated sub-res…
Get Transaction New Owned Relationship
Inspect individual related resources or retrieve their relationship linkage identifiers directly using dedicated sub-res…
Get Transaction New Owner
Inspect individual related resources or retrieve their relationship linkage identifiers directly using dedicated sub-res…
Get Transaction New Owner Relationship
Inspect individual related resources or retrieve their relationship linkage identifiers directly using dedicated sub-res…
Get Transaction Owned
Inspect individual related resources or retrieve their relationship linkage identifiers directly using dedicated sub-res…
Get Transaction Owned Relationship
Inspect individual related resources or retrieve their relationship linkage identifiers directly using dedicated sub-res…
Get Transaction Owner
Inspect individual related resources or retrieve their relationship linkage identifiers directly using dedicated sub-res…
Get Transaction Owner Relationship
Inspect individual related resources or retrieve their relationship linkage identifiers directly using dedicated sub-res…
Get Transaction View Results
Returns data based on the transactions view, portfolio, and time period.
Create Transactions
Creates one or more transactions.
Add Transaction Files
Attaches an existing file to the specified transaction.
Update Transaction
Updates attributes of existing transactions.
Update Transactions
Updates attributes of existing transactions.
Delete Transaction
Permanently removes transaction records from your firm.
Delete Transactions
Permanently removes transaction records from your firm.
Remove Transaction File
Removes the attachment link between a document and a transaction.
List Role Assigned User Relationships
Returns a list of IDs for all users assigned to a specific role.
List Role Assigned Users
Returns details about the users assigned to a specific role.
List Roles
Returns a list of all roles at the firm.
Get Role
Returns the details for a specific role.
Assign Users To Role
Assigns users to a role. A user already assigned to another role is moved to this one.
Update Users Assigned To Role
Updates the specified users assigned to a role.
Remove Role Assigned Users
Removes a specified user from a role.
List Team Members
Returns the IDs of all users in a team.
List Teams
Returns all teams, or a set of teams filtered by their IDs.
Get Team
Returns a team with the given ID.
Create Team
Creates a team of users.
Add Team Members
Adds users to an existing team.
Replace Team Members
Updates a team’s users by removing its existing users and replacing them with a new set of users.
Update Team
Updates a team’s information, like its name.
Delete Team
Deletes a team.
Remove Team Members
Removes specific users from a team.
List User Permissioned Entities
Retrieves a list of IDs for the clients or group portfolios that the user has access to.
List User Permissioned Groups
Retrieves a list of IDs for the clients or group portfolios that the user has access to.
List Users
Retrieves details for all users.
Query Users By Email
Retrieves details for a specific user.
Query Users By External ID
Retrieves details for a specific user.
Get Current User
Retrieves details for the currently authenticated user.
Get User
Retrieves details for a specific user.
Get User Assigned Role
If no role is assigned to a user, data will return as null.
Create User
By default, users are created in custom mode with no permissions.
Add User Permissioned Entities
Grants a user access to a specific client or group of portfolios.
Add User Permissioned Groups
Grants a user access to a specific client or group of portfolios.
Update User
Updates the user’s first_name, last_name, all_data_access, or admin_access.
Update User Assigned Role
Update User Assigned Role.
Delete User
Removes a specified user.
Remove User Permissioned Entities
Removes access to specific client and group portfolios.
Remove User Permissioned Groups
Removes access to specific client and group portfolios.