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

# Addepar

> How to set up the Addepar connector, plus the actions that are available.

![Addepar](https://stackone-logos.com/api/addepar/filled/svg)

Betav0.1.0[See changelog](https://docs.stackone.com/connectors/addepar/changelog.md)

[269 actions](#actions) · 2 auth methods

Security
Billing
CRM
Documents
IAM

## Getting Started

**1. Create or Select a Project**

Set up a new project or select an existing one. See [Organizations & Projects](https://docs.stackone.com/gateway/concepts/organizations-and-projects.md).

**2. Configure the Connector**

Enable the connector and create a Connector Profile in your project. See [Setup Connector Profile](https://docs.stackone.com/gateway/quickstart.md#setup-connector-profile).

> [card] [API Key · Connector Profile](https://docs.stackone.com/connectors/addepar/guides/connector-profile/api-key.md)
>
> Uses an API key and secret created by an Addepar user. Actions run with the tool and data permissions of that user.

> [card] [OAuth 2.0 · Connector Profile](https://docs.stackone.com/connectors/addepar/guides/connector-profile/oauth-2-0.md)
>
> 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](https://docs.stackone.com/connect/managing-connectors/linking-accounts.md#link-from-the-dashboard) (or via [StackOne Hub](https://docs.stackone.com/embed/account-linking/overview)).

See the guide for the authentication type chosen in the Connector Profile:

> [card] [API Key · Link Account](https://docs.stackone.com/connectors/addepar/guides/link-account/api-key.md)

> [card] [OAuth 2.0 · Link Account](https://docs.stackone.com/connectors/addepar/guides/link-account/oauth-2-0.md)

**4. Use Actions**

Connect an AI platform to the linked account's actions. See [AI Platforms](https://docs.stackone.com/ai-platforms/overview.md).

Other ways to call actions are listed in [Protocols & SDKs](https://docs.stackone.com/connect/protocols-and-sdks.md).

## Actions

Authentication type

Select all
|
Clear

API Key

OAuth 2.0

No auth methods found

Scopes

Select all
|
Clear

AUDIT\_TRAIL

BENCHMARKS\_READ

BENCHMARKS\_WRITE

BILLING\_READ

BILLING\_WRITE

COMPOSITE\_SECURITIES\_READ

COMPOSITE\_SECURITIES\_WRITE

ENTITIES

ENTITIES\_WRITE

ESTIMATED\_RETURNS\_READ

ESTIMATED\_RETURNS\_WRITE

FILES

FILES\_WRITE

GROUPS

GROUPS\_WRITE

HISTORICAL\_PRICES\_READ

HISTORICAL\_PRICES\_WRITE

PORTFOLIO

POSITIONS

POSITIONS\_WRITE

PUBLISH\_FILE

REPORTS\_READ

REPORTS\_WRITE

TEAMS

TEAMS\_WRITE

TRANSACTIONS

TRANSACTIONS\_WRITE

USERS

USERS\_READ

USERS\_WRITE

No scopes found

269 actions

ActionDescriptionRequired scopes

List Allocation Models`addepar_list_allocation_models`

Retrieve all allocation models that the user has permission to view.

Get Allocation Model`addepar_get_allocation_model`

Retrieve a specific allocation model by its ID.

Create Allocation Model`addepar_create_allocation_model`

Create a new allocation model with the specified attributes.

Update Allocation Model`addepar_update_allocation_model`

Update an existing allocation model.

Delete Allocation Model`addepar_delete_allocation_model`

Will delete an existing allocation model.

List Allocation Templates`addepar_list_allocation_templates`

Retrieve all allocation templates that the user has permission to view.

Get Allocation Template`addepar_get_allocation_template`

Retrieve a specific allocation template by its ID.

Create Allocation Template`addepar_create_allocation_template`

Create a new allocation template with the specified attributes.

Replace Allocation Template`addepar_replace_allocation_template`

Completely replace an existing allocation template with the provided data.

Update Allocation Template`addepar_update_allocation_template`

Update an existing allocation template.

Delete Allocation Template`addepar_delete_allocation_template`

Delete an existing allocation template.

Query Audit Trail`addepar_query_audit_trail`

Audit logs track changes to attribute values, transactions, reports, and user roles and permissions.

`AUDIT_TRAIL`

Get Audit Trail Record`addepar_get_audit_trail_record`

Retrieves details about a specific user action.

`AUDIT_TRAIL`

List Benchmark Associations Strategies`addepar_list_benchmark_associations_strategies`

Returns a paginated list of all active benchmark associations strategies.

`BENCHMARKS_READ`

Get Benchmark Associations Strategy`addepar_get_benchmark_associations_strategy`

Returns a benchmark associations strategy with the given ID.

`BENCHMARKS_READ`

Create Benchmark Associations Strategy`addepar_create_benchmark_associations_strategy`

Adds a new benchmark associations strategy to your firm.

`BENCHMARKS_WRITE`

Update Benchmark Associations Strategy`addepar_update_benchmark_associations_strategy`

Modifies an existing benchmark associations strategy.

`BENCHMARKS_WRITE`

Delete Benchmark Associations Strategy`addepar_delete_benchmark_associations_strategy`

Deletes an existing benchmark associations strategy if it exists.

`BENCHMARKS_WRITE`

List Benchmark Compositions`addepar_list_benchmark_compositions`

Returns a paginated list of all active benchmark compositions.

`BENCHMARKS_READ`

Get Benchmark Composition`addepar_get_benchmark_composition`

Returns a benchmark composition with the given ID.

`BENCHMARKS_READ`

Update Benchmark Composition`addepar_update_benchmark_composition`

Modifies the underlying composition of an existing blended benchmark.

`BENCHMARKS_WRITE`

List Benchmarks`addepar_list_benchmarks`

Returns a paginated list of all active benchmarks.

`BENCHMARKS_READ`

Get Benchmark`addepar_get_benchmark`

Returns a benchmark with the given ID.

`BENCHMARKS_READ`

Create Benchmark`addepar_create_benchmark`

Adds a new benchmark to your firm.

`BENCHMARKS_WRITE`

Update Benchmark`addepar_update_benchmark`

Modifies an existing benchmark.

`BENCHMARKS_WRITE`

Delete Benchmark`addepar_delete_benchmark`

Deletes a user-created benchmark if it exists.

`BENCHMARKS_WRITE`

Get Imported Benchmark Data`addepar_get_imported_benchmark_data`

Returns all the daily returns for an imported benchmark with the given ID.

`BENCHMARKS_READ`

Update Imported Benchmark Data`addepar_update_imported_benchmark_data`

Add new daily returns to an existing imported benchmark.

`BENCHMARKS_WRITE`

List Billable Portfolios`addepar_list_billable_portfolios`

Get multiple billable portfolio setups.

`BILLING_READ`

Get Billable Portfolio`addepar_get_billable_portfolio`

Get a single billable portfolio setup by it's id.

`BILLING_READ`

Create Billable Portfolio`addepar_create_billable_portfolio`

Set up a group or entity for billing with a specified fee schedule.

`BILLING_WRITE`

Bulk Archive Billable Portfolios`addepar_bulk_archive_billable_portfolios`

Archive multiple billable portfolios when you no longer want to bill on them.

`BILLING_WRITE`

Bulk Update Billable Portfolio Fee Schedules`addepar_bulk_update_billable_portfolio_fee_schedules`

Update multiple billable portfolios' fee schedules to different ones.

`BILLING_WRITE`

Update Billable Portfolio Fee Schedules`addepar_update_billable_portfolio_fee_schedules`

Update a billable portfolio's fee schedule to a different one.

`BILLING_WRITE`

Archive Billable Portfolio`addepar_archive_billable_portfolio`

Archive a billable portfolio when you no longer want to bill on it.

`BILLING_WRITE`

List Fee Schedule Fee Relationships`addepar_list_fee_schedule_fee_relationships`

Retrieves the fee relationships by fee schedule ID.

`BILLING_READ`

List Fee Schedule Fees`addepar_list_fee_schedule_fees`

Retrieves fees associated to a fee schedule by fee schedule ID.

`BILLING_READ`

List Fee Schedules`addepar_list_fee_schedules`

Retrieves all fee schedules.

`BILLING_READ`

Get Fee Schedule`addepar_get_fee_schedule`

Retrieves a fee schedule by ID.

`BILLING_READ`

Create Fee Schedules`addepar_create_fee_schedules`

Creates all fee schedules passed in the request body as a list.

`BILLING_WRITE`

Add Fee Schedule Fees`addepar_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.

`BILLING_WRITE`

Replace Fee Schedule`addepar_replace_fee_schedule`

Edits a fee schedule.

`BILLING_WRITE`

Replace Fee Schedule Fees`addepar_replace_fee_schedule_fees`

Replaces the entire list of fees associated with a fee schedule.

`BILLING_WRITE`

Replace Fee Schedules`addepar_replace_fee_schedules`

Edits a list of fee schedules.

`BILLING_WRITE`

Delete Fee Schedule`addepar_delete_fee_schedule`

Deletes a fee schedule.

`BILLING_WRITE`

Delete Fee Schedules`addepar_delete_fee_schedules`

Deletes a list of fee schedules.

`BILLING_WRITE`

Remove Fee Schedule Fees`addepar_remove_fee_schedule_fees`

Removes all associations with fees for the fee schedule.

`BILLING_WRITE`

List Fee Fee Schedules`addepar_list_fee_fee_schedules`

Retrieves fee schedules that have the fee with the ID.

`BILLING_READ`

List Fee Schedule Relationships`addepar_list_fee_schedule_relationships`

Retrieves the fee schedule relationships by fee ID.

`BILLING_READ`

List Fees`addepar_list_fees`

Retrieves all fees.

`BILLING_READ`

Get Fee`addepar_get_fee`

Retrieves a fee by its ID.

`BILLING_READ`

Create Fees`addepar_create_fees`

Creates all fees passed in the request body as a list.

`BILLING_WRITE`

Replace Fee`addepar_replace_fee`

Edits a fee.

`BILLING_WRITE`

Replace Fees`addepar_replace_fees`

Edits a list of fees.

`BILLING_WRITE`

Delete Fee`addepar_delete_fee`

Deletes a fee.

`BILLING_WRITE`

Delete Fees`addepar_delete_fees`

Deletes a list of fees.

`BILLING_WRITE`

Publish Files To Portal`addepar_publish_files_to_portal`

Requests to publish a file to the Client Portal.

`FILES_WRITE``PUBLISH_FILE`

List Contact Entity Affiliations`addepar_list_contact_entity_affiliations`

Retrieves a list of IDs for the entities or groups the contact has been affiliated with.

`USERS_READ`

List Contact Group Affiliations`addepar_list_contact_group_affiliations`

Retrieves a list of IDs for the entities or groups the contact has been affiliated with.

`USERS_READ`

List Contacts`addepar_list_contacts`

Retrieves details for all contacts.

`USERS_READ`

Get Contact`addepar_get_contact`

Retrieves details for a specific contact.

`USERS_READ`

Get Contact Default View Set`addepar_get_contact_default_view_set`

Retrieves the ID of the default view set assigned to the contact.

`USERS_READ`

Get Contact Team`addepar_get_contact_team`

Retrieves the ID of the contact’s team.

`USERS_READ`

Create Contact`addepar_create_contact`

Creates a new contact.

`USERS_WRITE`

Add Contact Entity Affiliations`addepar_add_contact_entity_affiliations`

Affiliates entities or groups with a contact.

`USERS_WRITE`

Add Contact Group Affiliations`addepar_add_contact_group_affiliations`

Affiliates entities or groups with a contact.

`USERS_WRITE`

Set Contact Default View Set`addepar_set_contact_default_view_set`

Assigns a view set as the default for a contact.

`USERS_WRITE`

Replace Contact Entity Affiliations`addepar_replace_contact_entity_affiliations`

Replaces a contacts entity or group affiliations with the given entities or groups.

`USERS_WRITE`

Replace Contact Group Affiliations`addepar_replace_contact_group_affiliations`

Replaces a contacts entity or group affiliations with the given entities or groups.

`USERS_WRITE`

Replace Contact Team`addepar_replace_contact_team`

Replaces a contact’s team.

`USERS_WRITE`

Update Contact`addepar_update_contact`

Updates a contact with the specified details.

`USERS_WRITE`

Disable Contact SAML`addepar_disable_contact_saml`

Disable a contact’s SAML settings to prevent a contact from using single sign-on (SSO).

`USERS_WRITE`

Enable Contact SAML`addepar_enable_contact_saml`

Enable a contact’s SAML settings to require that contact to use single sign-on (SSO).

`USERS_WRITE`

Make Contact Two Factor Authentication Optional`addepar_exempt_contact_two_factor_authentication`

Makes two-factor authentication (2FA) optional for a contact, exempting them from the firm's 2FA Client Portal login req...

`USERS_WRITE`

Invite Contact To Portal`addepar_invite_contact_to_portal`

Send or resend a Client Portal invite to a contact's login email address.

`USERS_WRITE`

Require Contact Two Factor Authentication`addepar_require_contact_two_factor_authentication`

Require an exempted contact to follow your firm’s 2FA Client Portal login requirement.

`USERS_WRITE`

Restore Contact Portal Access`addepar_restore_contact_portal_access`

Allow a client to once again sign into the Client Portal.

`USERS_WRITE`

Revoke Contact Portal Access`addepar_revoke_contact_portal_access`

Stop a client from being able to sign in to the Client Portal.

`USERS_WRITE`

Delete Contact`addepar_delete_contact`

Delete a specific contact.

`USERS_WRITE`

Remove Contact Default View Set`addepar_remove_contact_default_view_set`

Removes the default view set from a contact.

`USERS_WRITE`

Remove Contact Entity Affiliations`addepar_remove_contact_entity_affiliations`

Removes entities or groups from a contact’s affiliations.

`USERS_WRITE`

Remove Contact Group Affiliations`addepar_remove_contact_group_affiliations`

Removes entities or groups from a contact’s affiliations.

`USERS_WRITE`

Remove Contact Team`addepar_remove_contact_team`

Removes the team from a contact.

`USERS_WRITE`

List View Sets`addepar_list_view_sets`

Retrieves details for all view sets.

`USERS_READ`

Get View Set`addepar_get_view_set`

Retrieves details for a specific view set.

`USERS_READ`

List Constituent Attributes`addepar_list_constituent_attributes`

Retrieves all constituent attributes you have permission to access.

`ENTITIES`

Get Constituent Attribute`addepar_get_constituent_attribute`

Retrieves a specific attribute on a specific constituent.

`ENTITIES`

Create Constituent Attribute`addepar_create_constituent_attribute`

Adds an attribute value to a constituent, and returns the newly-added value.

`ENTITIES_WRITE`

Update Constituent Attribute`addepar_update_constituent_attribute`

Updates the value of a constituent's specified attribute.

`ENTITIES_WRITE`

Update Constituent Attributes`addepar_update_constituent_attributes`

Updates the values of multiple constituent attributes.

`ENTITIES_WRITE`

Delete Constituent Attribute`addepar_delete_constituent_attribute`

Removes an attribute value from a constituent.

`ENTITIES_WRITE`

Delete Constituent Attributes`addepar_delete_constituent_attributes`

Removes all attribute values associated with the provided ASM ID.

`ENTITIES_WRITE`

List Entities`addepar_list_entities`

Retrieves the full list of all entities you have permission to access, as well as all attributes for each entity.

`ENTITIES`

Get Entity`addepar_get_entity`

Retrieves all attributes for a specific entity.

`ENTITIES`

Create Entity`addepar_create_entity`

Adds a new entity to your firm.

`ENTITIES_WRITE`

Update Entities`addepar_update_entities`

Adds, modifies, or deletes attributes of existing entities.

`ENTITIES_WRITE`

Update Entity`addepar_update_entity`

Adds, modifies, or deletes the attributes or custom attributes of an existing entity.

`ENTITIES_WRITE`

Delete Entities`addepar_delete_entities`

Deletes multiple existing entities from your firm.

`ENTITIES_WRITE`

Delete Entity`addepar_delete_entity`

Deletes an existing entity from your firm.

`ENTITIES_WRITE`

List Estimated Returns`addepar_list_estimated_returns`

Returns estimated returns filtered by one or more entity IDs.

`ESTIMATED_RETURNS_READ`

Get Estimated Return`addepar_get_estimated_return`

Returns a single estimated return by its composite ID.

`ESTIMATED_RETURNS_READ`

Upsert Estimated Returns`addepar_upsert_estimated_returns`

Creates or updates estimated returns using upsert semantics.

`ESTIMATED_RETURNS_WRITE`

Update Estimated Return`addepar_update_estimated_return`

Updates the return value of an existing estimated return.

`ESTIMATED_RETURNS_WRITE`

Delete Entity Estimated Returns`addepar_delete_entity_estimated_returns`

Deletes all estimated returns for a specific entity.

`ESTIMATED_RETURNS_WRITE`

Delete Estimated Return`addepar_delete_estimated_return`

Deletes a single estimated return.

`ESTIMATED_RETURNS_WRITE`

List External ID Types`addepar_list_external_id_types`

Returns a list of all External ID Types.

`ENTITIES`

Get External ID Type`addepar_get_external_id_type`

Returns an External ID Type corresponding to the given ID.

`ENTITIES`

Create External ID Type`addepar_create_external_id_type`

Adds a new External ID Type to your firm.

`ENTITIES_WRITE`

Update External ID Type`addepar_update_external_id_type`

Modifies an existing External ID Type.

`ENTITIES_WRITE`

Delete External ID Type`addepar_delete_external_id_type`

Deletes an existing External ID Type from your firm.

`ENTITIES_WRITE`

List Entity Prices`addepar_list_entity_prices`

Returns an entity's historical prices.

`HISTORICAL_PRICES_READ`

Upsert Entity Prices`addepar_upsert_entity_prices`

Creates or updates historical prices for a given entity.

`HISTORICAL_PRICES_WRITE`

Delete Entity Price`addepar_delete_entity_price`

Deletes an entity's historical price on a specific date.

`HISTORICAL_PRICES_WRITE`

List Entity Types`addepar_list_entity_types`

Returns a list of all model types.

`ENTITIES`

Get Entity Type`addepar_get_entity_type`

Returns details about a specified model type.

`ENTITIES`

Update Entity Types`addepar_update_entity_types`

Updates the model type for select entities.

`ENTITIES_WRITE`

List Archived Files`addepar_list_archived_files`

Retrieves a list of all archived (deleted) files and/or folders, as well as information about when each was created, the...

`FILES`

Get Archived File`addepar_get_archived_file`

Retrieves an archived (deleted) file, as well as information about when it was created, the type of content it holds, it...

`FILES`

Download Archived File`addepar_download_archived_file`

Retrieves the raw contents of an archived file.

`FILES`

List File Associated Entities`addepar_list_file_associated_entities`

Retrieves the full object of entities associated with the file.

`FILES`

List File Associated Groups`addepar_list_file_associated_groups`

Retrieves the full object of groups associated with the file.

`FILES`

List Files`addepar_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...

`FILES`

Get File`addepar_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...

`FILES`

Download File`addepar_download_file`

Retrieves the raw contents of a specific file.

`FILES`

Create File`addepar_create_file`

Adds a new file to your firm.

`FILES_WRITE`

Add File Associated Entities`addepar_add_file_associated_entities`

Adds to the list of entities associated to the file.

`FILES_WRITE`

Add File Associated Groups`addepar_add_file_associated_groups`

Adds to the list of groups associated to the file.

`FILES_WRITE`

Replace File Associated Entities`addepar_replace_file_associated_entities`

Replaces all entities currently associated with different entities.

`FILES_WRITE`

Replace File Associated Groups`addepar_replace_file_associated_groups`

Replaces all groups currently associated with different groups.

`FILES_WRITE`

Update File`addepar_update_file`

Updates the attributes and relationships for a specific file.

`FILES_WRITE`

Delete File`addepar_delete_file`

Archives a file available in Addepar or a folder and everything in it.

`FILES_WRITE`

Remove File Associated Entities`addepar_remove_file_associated_entities`

Removes the list of entities specified from the file associations.

`FILES_WRITE`

Remove File Associated Groups`addepar_remove_file_associated_groups`

Removes the list of groups specified from the file associations.

`FILES_WRITE`

List Group Types`addepar_list_group_types`

Retrieve all group types for the firm.

`GROUPS`

Get Group Type`addepar_get_group_type`

Retrieve a group type using a group type key (same as ID).

`GROUPS`

Create Group Type`addepar_create_group_type`

Create a new group type for your firm.

`GROUPS_WRITE`

Update Group Type`addepar_update_group_type`

Change an existing group type's display name using the group type key (same as ID).

`GROUPS_WRITE`

Delete Group Type`addepar_delete_group_type`

Delete the group type using the group type key (same as ID).

`GROUPS_WRITE`

List Group Child Groups`addepar_list_group_child_groups`

Retrieve a group's child groups.

`GROUPS`

List Group Member Relationships`addepar_list_group_member_relationships`

Returns the resource identifiers (type and id) of a group's members, without member details.

`GROUPS`

List Group Members`addepar_list_group_members`

Returns the full entity records (member details) of a group's members.

`GROUPS`

List Groups`addepar_list_groups`

Retrieves all groups you have access to.

`GROUPS`

Query Groups`addepar_query_groups`

For a refined list of results, you can retrieve only groups with a specific display name, group type or external ID.

`GROUPS`

Get Group`addepar_get_group`

Retrieves a specific group based on its ID.

`GROUPS`

Create Group`addepar_create_group`

Adds a new group to your firm.

`GROUPS_WRITE`

Add Group Child Groups`addepar_add_group_child_groups`

Adds a new child group to an existing group.

`GROUPS_WRITE`

Add Group Members`addepar_add_group_members`

Adds existing entities as members to a group.

`GROUPS_WRITE`

Replace Group Child Groups`addepar_replace_group_child_groups`

Replaces all the existing group members with new ones.

`GROUPS_WRITE`

Replace Group Members`addepar_replace_group_members`

Replaces all the existing group members with new ones.

`GROUPS_WRITE`

Update Group`addepar_update_group`

Adds, modifies, or deletes the attributes of an existing group.

`GROUPS_WRITE`

Update Groups`addepar_update_groups`

Adds, modifies, or deletes attributes of existing groups.

`GROUPS_WRITE`

Delete Group`addepar_delete_group`

Deletes a group from your firm.

`GROUPS_WRITE`

Delete Groups`addepar_delete_groups`

Deletes multiple existing groups from your firm.

`GROUPS_WRITE`

Remove Group Members`addepar_remove_group_members`

Removes members of a group.

`GROUPS_WRITE`

Get Import`addepar_get_import`

Check an import's status by its ID.

Get Import Results`addepar_get_import_results`

See information about an import's results with digests, warnings, and errors.

Create Import`addepar_create_import`

Imports data for one import type.

Delete Import Data`addepar_delete_import_data`

Deletes data for one import type.

List Arguments`addepar_list_arguments`

Retrieves all attribute arguments supported by the Portfolio Query API.

`PORTFOLIO`

Get Argument`addepar_get_argument`

Retrieves the attribute argument with the given ID.

`PORTFOLIO`

List Attribute Argument Relationships`addepar_list_attribute_argument_relationships`

Retrieves the list of argument ids associated with the given attribute ID.

`PORTFOLIO`

List Attribute Arguments`addepar_list_attribute_arguments`

Retrieves the list of arguments associated with the given attribute ID.

`PORTFOLIO`

List Attributes`addepar_list_attributes`

Retrieves all attributes available to the user.

`PORTFOLIO`

Query Attributes`addepar_query_attributes`

Retrieves all attributes with matching attribute keys.

`PORTFOLIO`

Get Attribute`addepar_get_attribute`

Retrieves the attribute with the given ID.

`PORTFOLIO`

Get Composite Security Constituent`addepar_get_composite_security_constituent`

Returns a constituent's weight data from within a composite security.

`COMPOSITE_SECURITIES_READ`

Import Composite Security Constituents`addepar_import_composite_security_constituents`

Adds new constituent weight data to a composite security on a specific date.

`COMPOSITE_SECURITIES_WRITE`

Delete Composite Security Constituents`addepar_delete_composite_security_constituents`

Removes all constituent weight data from a composite security on a specific date.

`COMPOSITE_SECURITIES_WRITE`

List Jobs`addepar_list_jobs`

Retrieves the status and parameters of all jobs.

`PORTFOLIO`

Get Job`addepar_get_job`

Retrieves the status and parameters for a specific job.

`PORTFOLIO`

Download Job Results`addepar_download_job_results`

Returns the results of the given job.

`PORTFOLIO`

Create Batched Job`addepar_create_batched_job`

Configure portfolio view or query requests in batch mode for faster results.

`PORTFOLIO`

Create Portfolio Query Job`addepar_create_portfolio_query_job`

Creates an asynchronous job to extract portfolio data with a query.

`PORTFOLIO`

Create Portfolio View Job`addepar_create_portfolio_view_job`

Creates an asynchronous job to extract portfolio data for a saved view in Addepar.

`PORTFOLIO`

Cancel Job`addepar_cancel_job`

Cancel a job that is has yet to start, is running, or already completed.

`PORTFOLIO`

List Portfolio Views`addepar_list_portfolio_views`

Get a complete list of views for portfolios you have access to.

`PORTFOLIO`

Query Portfolio`addepar_query_portfolio`

Returns portfolio data based on the given query parameters.

`PORTFOLIO`

Get Portfolio View`addepar_get_portfolio_view`

Returns a complete request body to quickly query on a portfolio view.

`PORTFOLIO`

Get Portfolio View Results`addepar_get_portfolio_view_results`

Returns portfolio data based on the analysis view, portfolio, and time period.

`PORTFOLIO`

List Positions`addepar_list_positions`

Returns details for all positions, including inception information and relationships.

`POSITIONS`

Get Position`addepar_get_position`

Returns details for the specified position, including inception information and relationships.

`POSITIONS`

Get Position Owned`addepar_get_position_owned`

Returns the owned entity.

`POSITIONS`

Get Position Owned Relationship`addepar_get_position_owned_relationship`

Returns the relationship of the owned entity.

`POSITIONS`

Get Position Owner`addepar_get_position_owner`

Returns the owner entity.

`POSITIONS`

Get Position Owner Relationship`addepar_get_position_owner_relationship`

Returns the relationship of the owner entity.

`POSITIONS`

Create Position`addepar_create_position`

Creates a new open position.

`POSITIONS_WRITE`

Update Position`addepar_update_position`

Updates the specified position.

`POSITIONS_WRITE`

Update Positions`addepar_update_positions`

Updates the specified open positions.

`POSITIONS_WRITE`

Delete Position`addepar_delete_position`

Removes a specified position.

`POSITIONS_WRITE`

Delete Positions`addepar_delete_positions`

Removes the specified positions.

`POSITIONS_WRITE`

List Generated Reports`addepar_list_generated_reports`

Retrieves all generated reports that a user is authenticated to view, sorted in reverse chronological order of completio...

`FILES`

Get Generated Report`addepar_get_generated_report`

Retrieves a generated report by its report generation job ID.

`FILES`

Get Generated Report Creator`addepar_get_generated_report_creator`

Retrieves all information related to the user who generated the reports for the job id.

`FILES``USERS`

Get Generated Report Zipped File`addepar_get_generated_report_zipped_file`

Retrieves all information related to the zipped file generated for the job ID.

`FILES`

Download Generated Report Zipped File`addepar_download_generated_report_zipped_file`

Returns a binary zipped file.

`FILES`

Run Report`addepar_create_report_generation_job`

Runs a report, generating a PDF for each associated and specified portfolio.

`REPORTS_WRITE`

List Reports`addepar_list_reports`

Obtain a list of reports to use as a starting point for other API workflows.

`REPORTS_READ`

Get Snapshot`addepar_get_snapshot`

Returns a snapshot or valuation with the given ID.

`TRANSACTIONS`

Get Snapshot Owned`addepar_get_snapshot_owned`

Returns the owned entity of the snapshot or valuation.

`TRANSACTIONS`

Get Snapshot Owned Relationship`addepar_get_snapshot_owned_relationship`

Returns the relationship of the owned entity.

`TRANSACTIONS`

Get Snapshot Owner`addepar_get_snapshot_owner`

Returns the owner entity of the snapshot or valuation.

`TRANSACTIONS`

Get Snapshot Owner Relationship`addepar_get_snapshot_owner_relationship`

Returns the relationship of the owner entity.

`TRANSACTIONS`

Get Snapshot Position`addepar_get_snapshot_position`

Returns the snapshot or valuation's position with the given ID.

`TRANSACTIONS`

Get Snapshot Position Relationship`addepar_get_snapshot_position_relationship`

Returns the snapshot or valuation's position relationship.

`TRANSACTIONS`

Create Snapshot`addepar_create_snapshot`

Adds a new snapshot or valuation to your firm.

`TRANSACTIONS_WRITE`

Update Snapshot`addepar_update_snapshot`

Modifies an existing snapshot or valuation.

`TRANSACTIONS_WRITE`

Update Snapshots`addepar_update_snapshots`

Modifies existing snapshots or valuations.

`TRANSACTIONS_WRITE`

Delete Snapshot`addepar_delete_snapshot`

Deletes an existing snapshot or valuation if it exists.

`TRANSACTIONS_WRITE`

Delete Snapshots`addepar_delete_snapshots`

Deletes existing snapshots or valuations.

`TRANSACTIONS_WRITE`

List Transaction Jobs`addepar_list_transaction_jobs`

Retrieves the status and parameters of all jobs.

`TRANSACTIONS`

Get Transaction Job`addepar_get_transaction_job`

Retrieves the status and parameters for a specific job.

`TRANSACTIONS`

Get Transaction Job Creator`addepar_get_transaction_job_creator`

Retrieves the user who created the job.

`TRANSACTIONS`

Get Transaction Job Creator Relationship`addepar_get_transaction_job_creator_relationship`

Retrieves the relationship of the job creator.

`TRANSACTIONS`

Download Transaction Job Results`addepar_download_transaction_job_results`

Returns the results of the given job.

`TRANSACTIONS`

Create Transaction Job`addepar_create_transaction_job`

Creates an asynchronous job to extract transaction data for a saved transaction view in Addepar.

`TRANSACTIONS`

Cancel Transaction Job`addepar_cancel_transaction_job`

Cancel a job that is has yet to start, is running, or already completed.

`TRANSACTIONS`

List Transaction Files`addepar_list_transaction_files`

Retrieves visible document metadata attached to a transaction.

`TRANSACTIONS``FILES`

Query Transactions`addepar_query_transactions`

Returns transaction data based on the given query parameters.

`TRANSACTIONS`

Get Transaction`addepar_get_transaction`

Retrieves a single transaction by ID, including attributes, calculated values, relationship links, and self links.

`TRANSACTIONS`

Get Transaction Cash Position`addepar_get_transaction_cash_position`

Inspect individual related resources or retrieve their relationship linkage identifiers directly using dedicated sub-res...

`TRANSACTIONS`

Get Transaction Cash Position Relationship`addepar_get_transaction_cash_position_relationship`

Inspect individual related resources or retrieve their relationship linkage identifiers directly using dedicated sub-res...

`TRANSACTIONS`

Get Transaction New Owned`addepar_get_transaction_new_owned`

Inspect individual related resources or retrieve their relationship linkage identifiers directly using dedicated sub-res...

`TRANSACTIONS`

Get Transaction New Owned Relationship`addepar_get_transaction_new_owned_relationship`

Inspect individual related resources or retrieve their relationship linkage identifiers directly using dedicated sub-res...

`TRANSACTIONS`

Get Transaction New Owner`addepar_get_transaction_new_owner`

Inspect individual related resources or retrieve their relationship linkage identifiers directly using dedicated sub-res...

`TRANSACTIONS`

Get Transaction New Owner Relationship`addepar_get_transaction_new_owner_relationship`

Inspect individual related resources or retrieve their relationship linkage identifiers directly using dedicated sub-res...

`TRANSACTIONS`

Get Transaction Owned`addepar_get_transaction_owned`

Inspect individual related resources or retrieve their relationship linkage identifiers directly using dedicated sub-res...

`TRANSACTIONS`

Get Transaction Owned Relationship`addepar_get_transaction_owned_relationship`

Inspect individual related resources or retrieve their relationship linkage identifiers directly using dedicated sub-res...

`TRANSACTIONS`

Get Transaction Owner`addepar_get_transaction_owner`

Inspect individual related resources or retrieve their relationship linkage identifiers directly using dedicated sub-res...

`TRANSACTIONS`

Get Transaction Owner Relationship`addepar_get_transaction_owner_relationship`

Inspect individual related resources or retrieve their relationship linkage identifiers directly using dedicated sub-res...

`TRANSACTIONS`

Get Transaction View Results`addepar_get_transaction_view_results`

Returns data based on the transactions view, portfolio, and time period.

`TRANSACTIONS`

Create Transactions`addepar_create_transactions`

Creates one or more transactions.

`TRANSACTIONS_WRITE`

Add Transaction Files`addepar_add_transaction_files`

Attaches an existing file to the specified transaction.

`TRANSACTIONS_WRITE``FILES_WRITE`

Update Transaction`addepar_update_transaction`

Updates attributes of existing transactions.

`TRANSACTIONS_WRITE`

Update Transactions`addepar_update_transactions`

Updates attributes of existing transactions.

`TRANSACTIONS_WRITE`

Delete Transaction`addepar_delete_transaction`

Permanently removes transaction records from your firm.

`TRANSACTIONS_WRITE`

Delete Transactions`addepar_delete_transactions`

Permanently removes transaction records from your firm.

`TRANSACTIONS_WRITE`

Remove Transaction File`addepar_remove_transaction_file`

Removes the attachment link between a document and a transaction.

`TRANSACTIONS_WRITE``FILES_WRITE`

List Role Assigned User Relationships`addepar_list_role_assigned_user_relationships`

Returns a list of IDs for all users assigned to a specific role.

`USERS`

List Role Assigned Users`addepar_list_role_assigned_users`

Returns details about the users assigned to a specific role.

`USERS`

List Roles`addepar_list_roles`

Returns a list of all roles at the firm.

`USERS`

Get Role`addepar_get_role`

Returns the details for a specific role.

`USERS`

Assign Users To Role`addepar_add_role_assigned_users`

Assigns users to a role. A user already assigned to another role is moved to this one.

`USERS_WRITE`

Update Users Assigned To Role`addepar_replace_role_assigned_users`

Updates the specified users assigned to a role.

`USERS_WRITE`

Remove Role Assigned Users`addepar_remove_role_assigned_users`

Removes a specified user from a role.

`USERS_WRITE`

List Team Members`addepar_list_team_members`

Returns the IDs of all users in a team.

`TEAMS`

List Teams`addepar_list_teams`

Returns all teams, or a set of teams filtered by their IDs.

`TEAMS`

Get Team`addepar_get_team`

Returns a team with the given ID.

`TEAMS`

Create Team`addepar_create_team`

Creates a team of users.

`TEAMS_WRITE`

Add Team Members`addepar_add_team_members`

Adds users to an existing team.

`TEAMS_WRITE`

Replace Team Members`addepar_replace_team_members`

Updates a team's users by removing its existing users and replacing them with a new set of users.

`TEAMS_WRITE`

Update Team`addepar_update_team`

Updates a team's information, like its name.

`TEAMS_WRITE`

Delete Team`addepar_delete_team`

Deletes a team.

`TEAMS_WRITE`

Remove Team Members`addepar_remove_team_members`

Removes specific users from a team.

`TEAMS_WRITE`

List User Permissioned Entities`addepar_list_user_permissioned_entities`

Retrieves a list of IDs for the clients or group portfolios that the user has access to.

`USERS`

List User Permissioned Groups`addepar_list_user_permissioned_groups`

Retrieves a list of IDs for the clients or group portfolios that the user has access to.

`USERS`

List Users`addepar_list_users`

Retrieves details for all users.

`USERS`

Query Users By Email`addepar_query_users_by_email`

Retrieves details for a specific user.

`USERS`

Query Users By External ID`addepar_query_users_by_external_id`

Retrieves details for a specific user.

`USERS`

Get Current User`addepar_get_current_user`

Retrieves details for the currently authenticated user.

`USERS`

Get User`addepar_get_user`

Retrieves details for a specific user.

`USERS`

Get User Assigned Role`addepar_get_user_assigned_role`

If no role is assigned to a user, data will return as null.

`USERS`

Create User`addepar_create_user`

By default, users are created in custom mode with no permissions.

`USERS_WRITE`

Add User Permissioned Entities`addepar_add_user_permissioned_entities`

Grants a user access to a specific client or group of portfolios.

`USERS_WRITE`

Add User Permissioned Groups`addepar_add_user_permissioned_groups`

Grants a user access to a specific client or group of portfolios.

`USERS_WRITE`

Update User`addepar_update_user`

Updates the user's first\_name, last\_name, all\_data\_access, or admin\_access.

`USERS_WRITE`

Update User Assigned Role`addepar_update_user_assigned_role`

Update User Assigned Role.

`USERS_WRITE`

Delete User`addepar_delete_user`

Removes a specified user.

`USERS_WRITE`

Remove User Permissioned Entities`addepar_remove_user_permissioned_entities`

Removes access to specific client and group portfolios.

`USERS_WRITE`

Remove User Permissioned Groups`addepar_remove_user_permissioned_groups`

Removes access to specific client and group portfolios.

`USERS_WRITE`


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