Addepar

App · 25 actions

Automate Addepar, the wealth management platform: keep clients, accounts and households in step with your other systems, run portfolio views and queries, record transactions, file documents and manage contacts. Start a workflow when a client, account, transaction, file or contact is added.

Actions

ActionWhat it does
Create contactAdd a contact, someone who can be given the Client Portal, affiliated with the clients or groups they belong to.
Create entityAdd an entity to Addepar, such as a client, a trust, a holding account or an investment.
Create groupAdd a group, such as a household, of clients, accounts, trusts, holding companies or managed funds.
Create transactionRecord a transaction, such as a capital call, a contribution, a distribution, a fee or a trade.
Delete contactDelete a contact from Addepar.
Delete entityDelete an entity from Addepar for good.
Delete fileDelete a file or folder from Addepar's file vault.
Delete groupDelete a group from Addepar.
Delete transactionDelete a transaction from Addepar for good, taking it out of the portfolio's balances and history.
Find contactsFind contacts, the people who can be given the Client Portal, by email, by words in their name, or by an entity they're affiliated with.
Find entitiesFind clients, accounts, trusts, investments and other entities by type, by words in their name, or by when they were added or last changed.
Find filesFind files in Addepar's file vault, by the client, group or folder they're in, or when they were added.
Find groupsFind groups, such as households, by name, type, or when they were added or last changed.
Find transactionsFind transactions traded between two dates in a client, account, group or the whole firm, such as last week's contributions.
Get entityGet an entity's details, such as a client's or an account's, with all its attributes.
Get groupGet a group's details, with the IDs of its members and of the groups inside it.
Get portfolio jobPick up the results of a portfolio view or query run in the background, waiting until Addepar has finished it.
Get transactionGet a transaction's details, with the entities it is between.
List saved viewsList the saved analysis views you can run with 'Run portfolio view', such as to run each of them in turn.
Run portfolio queryGet chosen columns, such as value or time weighted return, for a client, account, group or the whole firm over a period, grouped as you choose, such as by asset class.
Run portfolio viewRun a saved analysis view on a client, account, group or the whole firm for a period, and get its values as rows.
Update contactChange a contact's details, or affiliate them with more clients or groups.
Update entityChange an entity's name, display name, currency or other attributes.
Update groupRename a group, add members to it or take members out.
Upload fileUpload a file to Addepar's file vault, such as a statement, linked to the clients or groups it's about.

Create contact

Add a contact, someone who can be given the Client Portal, affiliated with the clients or groups they belong to. Adding them doesn't invite them.

Inputs

First namefirst_nametextRequired
Their first name, up to 40 characters.
Last namelast_nametextRequired
Their last name, up to 80 characters.
Emailemailtext
Their email.
Email typeemail_typetext
What kind of email it is. Leave blank for work.One of: WORK, PERSONAL, FAMILY, OTHER. Default: WORK.
Phonephonetext
A phone number, up to 15 characters, such as 9179999999.
Phone typephone_typetext
What kind of number it is. Leave blank for mobile.One of: CELL (Mobile), WORK, HOME, FAX, OTHER. Default: CELL.
Client Portal emaillogin_emailtext
The email they would sign in to the Client Portal with.
Titletitletext
Their title, such as Mr. or Dr.
Suffixsuffixtext
Their suffix, such as Jr.
Employeremployertext
Who they work for.
Occupationoccupationtext
What they do.
Birthdaybirthdaydate
Their date of birth.
Your ID for themexternal_user_idtext
Your firm's own ID for them, such as their ID in your CRM, up to 31 characters.
Streetstreettext
Their street address.
Citycitytext
Their city.
Statestatetext
Their state or province.
ZIP or postcodepostcodetext
Their ZIP or postcode.
Countrycountrytext
Their country.
Entitiesentitieslist
The IDs of the clients or other entities to affiliate them with.
Groupsgroupslist
The IDs of the groups to affiliate them with.

Outputs

birthdaytext
Their birthday (YYYY-MM-DD)
emailtext
Their first email
emailslist
All their emails
employertext
Their employer
entity_idslist
The entities they are affiliated with
external_user_idtext
Your firm's own ID for them
first_nametext
Their first name
group_idslist
The groups they are affiliated with
idtext
The contact's ID
last_nametext
Their last name
login_emailtext
The email they sign in to the Client Portal with
mailing_addresseslist
Their mailing addresses
nametext
Their full name
occupationtext
Their occupation
phonetext
Their first phone number
phone_numberslist
All their phone numbers
portal_accesstext
Their Client Portal access, such as deactivated
suffixtext
Their suffix, such as Jr.
titletext
Their title, such as Mr.
Example output
{
  "birthday": "1990-10-31",
  "email": "example@addepar.com",
  "emails": [
    {
      "email": "example@addepar.com",
      "type": "WORK"
    }
  ],
  "employer": "Addepar",
  "entity_ids": [
    "22"
  ],
  "external_user_id": "abc123",
  "first_name": "Adam",
  "group_ids": [],
  "id": "2000",
  "last_name": "Smith",
  "login_email": "adam.smith@example.com",
  "mailing_addresses": [
    {
      "city": "New York",
      "country": "United States",
      "state": "New York",
      "street": "335 Madison Ave",
      "street2": "25th Floor",
      "type": "Work",
      "zip": "10017"
    }
  ],
  "name": "Adam Smith",
  "occupation": "Financial Services",
  "phone": "0987654321",
  "phone_numbers": [
    {
      "number": "0987654321",
      "type": "WORK"
    }
  ],
  "portal_access": "deactivated",
  "suffix": "Jr.",
  "title": "Mr."
}

Create entity

Add an entity to Addepar, such as a client, a trust, a holding account or an investment.

Inputs

NamenametextRequired
What the entity is called.
Typeentity_typetextRequired
What kind of entity it is, such as Client, Trust or Holding account.
Currencycurrencytext
Its currency, such as USD. Leave blank for USD.
Display namedisplay_nametext
A name to show in its place, such as an account's nickname.
Other attributesattributesobject
Other attributes by their API field name, such as {"asset_class": "Equity"}. An attribute's API field name is under Firm Administration > Attributes in Addepar.

Outputs

attributesobject
Its other attributes, by their API field name
created_attext
When it was added (ISO 8601)
currencytext
Its currency, such as USD
display_nametext
The name shown in its place, if one is set
idtext
The entity's ID
modified_attext
When it last changed (ISO 8601)
nametext
Its name as Addepar shows it: its display name, or its name
original_nametext
Its name
ownership_typetext
How it is owned: PERCENT_BASED, SHARE_BASED or VALUE_BASED; empty for a client
typetext
Its type, as Addepar stores it, such as PERSON_NODE
type_nametext
Its type as Addepar's app names it, such as Client
Example output
{
  "attributes": {
    "is_rolled_up": false
  },
  "created_at": "2023-07-28T02:24:30Z",
  "currency": "USD",
  "display_name": "Citco",
  "id": "1000002",
  "modified_at": "2023-07-30T10:43:21Z",
  "name": "Citco",
  "original_name": "X092849032",
  "ownership_type": "PERCENT_BASED",
  "type": "FINANCIAL_ACCOUNT",
  "type_name": "Holding account"
}

Create group

Add a group, such as a household, of clients, accounts, trusts, holding companies or managed funds.

Inputs

NamenametextRequired
What the group is called.
Group typegroup_typetext
What kind of group it is. Leave blank for Addepar's standard groups.
Membersmemberslist
The entity IDs of its members, such as 1000001.

Outputs

attributesobject
Its other attributes, by their API field name
child_group_idslist
The IDs of the groups inside it
created_attext
When it was added (ISO 8601)
group_typetext
Its group type, such as GROUPS
idtext
The group's ID
member_idslist
The entity IDs of its members
modified_attext
When it last changed (ISO 8601)
nametext
Its name
Example output
{
  "attributes": {},
  "child_group_ids": [
    "6"
  ],
  "created_at": "2023-07-28T02:24:30Z",
  "group_type": "GROUPS",
  "id": "5",
  "member_ids": [
    "22",
    "24",
    "117"
  ],
  "modified_at": "2023-07-30T10:43:21Z",
  "name": "Group 1"
}

Create transaction

Record a transaction, such as a capital call, a contribution, a distribution, a fee or a trade. It changes the portfolio's balances and performance.

Inputs

Typetransaction_typetextRequired
What kind of transaction it is.One of: account_fee (Account fee), account_fee_advisor (Account fee (advisor)), account_fee_bank (Account fee (bank)), account_fee_custodian (Account fee (custodian)), account_fee_management (Account fee (management)), account_fee_professional (Account fee (professional)), account_fee_reimbursement (Account fee reimbursement), account_fee_reimbursement_advisor (Account fee reimbursement (advisor)), account_fee_reimbursement_bank (Account fee reimbursement (bank)), account_fee_reimbursement_custodian (Account fee reimbursement (custodian)), and 63 more.
Investment or accountownedtextRequired
The investment or account's ID, a number such as 1000002, from another Addepar step or the trigger.
Held byownertext
The client, account or other entity that holds it's ID, a number such as 1000002, from another Addepar step or the trigger. Leave blank only for an account fee, which goes on the account alone.
Trade datetrade_datedateRequired
The day it happened.
Currencycurrencytext
Its currency, such as USD. Leave blank for USD.
Amountamountnumber
Its gross amount, such as 50000. Needed for a contribution, a distribution, a fee or a value-based investment.
Unitsunitsnumber
How many shares or units, for a trade such as a buy.
Cash positioncash_positiontext
The cash position's ID, a number such as 1000002, from another Addepar step or the trigger. The position its cash is paid to or from, if you know it.
Posted dateposted_datedate
The day the custodian reported it.
Settlement datesettlement_datedate
The day it settles.
Descriptiondescriptiontext
A description of it.
Commentcommenttext
Your firm's note on it.
Other fieldsother_fieldsobject
Other fields by their API name, such as how a distribution splits: {"return_of_capital": 1000}. Without one, a distribution's amount is recorded as generic and a cash dividend's as its dividend.

Outputs

amountnumber
Its gross amount; 0 if not set
attributesobject
Its other fields, by their API name
base_valuenumber
Its value in the firm's currency, as Addepar works it out
cancelledtrue/false
True if it was cancelled, which keeps it out of balances
cash_position_idtext
The cash position it is paid to or from; empty if none
commenttext
Your firm's note on it
created_attext
When it was added (ISO 8601)
currencytext
Its currency, such as USD
descriptiontext
The custodian's description
feenumber
Its fees; 0 if none
idtext
The transaction's ID
modified_attext
When it last changed (ISO 8601)
owned_idtext
The investment or account it is in
owner_idtext
The entity that holds it, such as an account; empty for none
posted_datetext
The day the custodian reported it; empty if not set
settlement_datetext
The day it settles; empty if not set
tagslist
Its tags
trade_datetext
The day it happened (YYYY-MM-DD)
typetext
Its type, as Addepar stores it, such as buy
type_nametext
Its type in words, such as Buy
unitsnumber
How many shares or units; 0 if not set
Example output
{
  "amount": 0,
  "attributes": {
    "calculation_date": "2025-05-15"
  },
  "base_value": 10000,
  "cancelled": false,
  "cash_position_id": "315",
  "comment": "Random comment",
  "created_at": "",
  "currency": "USD",
  "description": "",
  "fee": 0,
  "id": "1967",
  "modified_at": "",
  "owned_id": "199",
  "owner_id": "196",
  "posted_date": "",
  "settlement_date": "",
  "tags": [
    "Unknown"
  ],
  "trade_date": "2019-01-02",
  "type": "buy",
  "type_name": "Buy",
  "units": 100
}

Delete contact

Delete a contact from Addepar. They lose any Client Portal access.

Inputs

ContactcontacttextRequired
The contact's ID, a number such as 1000002, from another Addepar step or the trigger.

Outputs

deletedtrue/false
True once deleted
idtext
The record's ID
Example output
{
  "deleted": true,
  "id": "1111"
}

Delete entity

Delete an entity from Addepar for good. Addepar refuses one that holds other entities or has positions.

Inputs

EntityentitytextRequired
The entity's ID, a number such as 1000002, from another Addepar step or the trigger.

Outputs

deletedtrue/false
True once deleted
idtext
The record's ID
Example output
{
  "deleted": true,
  "id": "1111"
}

Delete file

Delete a file or folder from Addepar's file vault. Addepar keeps it in its archive.

Inputs

FilefiletextRequired
The file or folder's ID, a number such as 1000002, from another Addepar step or the trigger.

Outputs

deletedtrue/false
True once deleted
idtext
The record's ID
Example output
{
  "deleted": true,
  "id": "1111"
}

Delete group

Delete a group from Addepar. Its members stay in Addepar.

Inputs

GroupgrouptextRequired
The group's ID, a number such as 1000002, from another Addepar step or the trigger.

Outputs

deletedtrue/false
True once deleted
idtext
The record's ID
Example output
{
  "deleted": true,
  "id": "1111"
}

Delete transaction

Delete a transaction from Addepar for good, taking it out of the portfolio's balances and history.

Inputs

TransactiontransactiontextRequired
The transaction's ID, a number such as 1000002, from another Addepar step or the trigger.

Outputs

deletedtrue/false
True once deleted
idtext
The record's ID
Example output
{
  "deleted": true,
  "id": "1111"
}

Find contacts

Find contacts, the people who can be given the Client Portal, by email, by words in their name, or by an entity they're affiliated with.

Inputs

Emailemailtext
Any of their emails, or their portal email.
Namenametext
Words in their name, such as Smith.
Entityentitytext
The entity's ID, a number such as 1000002, from another Addepar step or the trigger. Only contacts affiliated with this client or other entity.
How manylimitnumber
The most to list. Defaults to 100.From 1 to 500.

Outputs

contactslist
The contacts found
countnumber
How many are listed
Example output
{
  "contacts": [
    {
      "birthday": "1990-10-31",
      "email": "example@addepar.com",
      "emails": [
        {
          "email": "example@addepar.com",
          "type": "WORK"
        }
      ],
      "employer": "Addepar",
      "entity_ids": [
        "22"
      ],
      "external_user_id": "abc123",
      "first_name": "Adam",
      "group_ids": [],
      "id": "2000",
      "last_name": "Smith",
      "login_email": "adam.smith@example.com",
      "mailing_addresses": [
        {
          "city": "New York",
          "country": "United States",
          "state": "New York",
          "street": "335 Madison Ave",
          "street2": "25th Floor",
          "type": "Work",
          "zip": "10017"
        }
      ],
      "name": "Adam Smith",
      "occupation": "Financial Services",
      "phone": "0987654321",
      "phone_numbers": [
        {
          "number": "0987654321",
          "type": "WORK"
        }
      ],
      "portal_access": "deactivated",
      "suffix": "Jr.",
      "title": "Mr."
    }
  ],
  "count": 1
}

Find entities

Find clients, accounts, trusts, investments and other entities by type, by words in their name, or by when they were added or last changed. Choose a type to search faster.

Inputs

Typestypeslist
Only entities of these types, such as Client or Holding account. Leave blank for every type.
Namenametext
Words in the entity's name, such as Smith.
Added on or aftercreated_afterdate
Only entities added on or after this day.
Changed on or aftermodified_afterdate
Only entities changed on or after this day.
How manylimitnumber
The most to list. Defaults to 100.From 1 to 500.

Outputs

countnumber
How many are listed
entitieslist
The entities found
Example output
{
  "count": 1,
  "entities": [
    {
      "attributes": {
        "is_rolled_up": false
      },
      "created_at": "2023-07-28T02:24:30Z",
      "currency": "USD",
      "display_name": "Citco",
      "id": "1000002",
      "modified_at": "2023-07-30T10:43:21Z",
      "name": "Citco",
      "original_name": "X092849032",
      "ownership_type": "PERCENT_BASED",
      "type": "FINANCIAL_ACCOUNT",
      "type_name": "Holding account"
    }
  ]
}

Find files

Find files in Addepar's file vault, by the client, group or folder they're in, or when they were added.

Inputs

Entityentitytext
The entity's ID, a number such as 1000002, from another Addepar step or the trigger. Only files linked to this client or other entity.
Groupgrouptext
The group's ID, a number such as 1000002, from another Addepar step or the trigger. Only files linked to this group.
Folderfoldertext
The folder's ID, a number such as 1000002, from another Addepar step or the trigger. Only what is in this folder.
Added aftercreated_afterdate and time
Only files added after this time.
Listincludetext
Files, folders or both. Leave blank for files.One of: FILES_ONLY (Files), FOLDERS_ONLY (Folders), FILES_AND_FOLDERS (Files and folders). Default: FILES_ONLY.
How manylimitnumber
The most to list. Defaults to 100.From 1 to 500.

Outputs

countnumber
How many are listed
fileslist
The files found
Example output
{
  "count": 1,
  "files": [
    {
      "bytes": 256201,
      "content_type": "application/PDF",
      "created_at": "2014-06-20T20:55:07Z",
      "entity_ids": [
        "10000",
        "10001"
      ],
      "group_ids": [
        "1234",
        "5678"
      ],
      "id": "123",
      "is_folder": false,
      "modified_at": "",
      "name": "Sample.pdf",
      "parent_folder_id": ""
    }
  ]
}

Find groups

Find groups, such as households, by name, type, or when they were added or last changed.

Inputs

Namenametext
Words in the group's name.
Group typegroup_typetext
Only groups of this type. Leave blank for every type.
Added on or aftercreated_afterdate
Only groups added on or after this day.
Changed on or aftermodified_afterdate
Only groups changed on or after this day.
How manylimitnumber
The most to list. Defaults to 100.From 1 to 500.

Outputs

countnumber
How many are listed
groupslist
The groups found
Example output
{
  "count": 1,
  "groups": [
    {
      "attributes": {},
      "child_group_ids": [
        "6"
      ],
      "created_at": "2023-07-28T02:24:30Z",
      "group_type": "GROUPS",
      "id": "5",
      "member_ids": [
        "22",
        "24",
        "117"
      ],
      "modified_at": "2023-07-30T10:43:21Z",
      "name": "Group 1"
    }
  ]
}

Find transactions

Find transactions traded between two dates in a client, account, group or the whole firm, such as last week's contributions.

Inputs

Run it onportfolio_typetext
Which portfolio. Leave blank for the whole firm.One of: ENTITY (A client, account or other entity), GROUP (A group), FIRM (The whole firm), FIRM_CLIENTS (Every client), FIRM_ACCOUNTS (Every account), FIRM_HOUSEHOLDS (Every household), FIRM_UNVERIFIED_ACCOUNTS (Every unverified account). Default: FIRM.
Portfolioportfoliotext
The entity or group's ID, such as 1000002. Give several, separated by commas, to run it on them together. Needed for a client, account or group.Only when Run it on is A client, account or other entity or A group.
Traded fromfrom_datedate
The first trade date. Leave blank for 30 days before the last.
Traded toto_datedate
The last trade date. Leave blank for today.
Typestypeslist
Only transactions of these types. Leave blank for every type.One or more of: account_fee (Account fee), account_fee_advisor (Account fee (advisor)), account_fee_bank (Account fee (bank)), account_fee_custodian (Account fee (custodian)), account_fee_management (Account fee (management)), account_fee_professional (Account fee (professional)), account_fee_reimbursement (Account fee reimbursement), account_fee_reimbursement_advisor (Account fee reimbursement (advisor)), account_fee_reimbursement_bank (Account fee reimbursement (bank)), account_fee_reimbursement_custodian (Account fee reimbursement (custodian)), and 63 more.
How manylimitnumber
The most to list. Defaults to 100.From 1 to 500.

Outputs

countnumber
How many are listed
transactionslist
The transactions found
Example output
{
  "count": 1,
  "transactions": [
    {
      "created_date": "",
      "currency": "",
      "description": "",
      "id": "1976",
      "owner_id": "208",
      "owner_name": "11112222",
      "posted_date": "",
      "security_id": "20",
      "security_name": "USD",
      "settlement_date": "",
      "trade_date": "2020-01-03",
      "type": "Distribution",
      "units": 0,
      "value": -100100
    }
  ]
}

Get entity

Get an entity's details, such as a client's or an account's, with all its attributes.

Inputs

EntityentitytextRequired
The entity's ID, a number such as 1000002, from another Addepar step or the trigger.

Outputs

attributesobject
Its other attributes, by their API field name
created_attext
When it was added (ISO 8601)
currencytext
Its currency, such as USD
display_nametext
The name shown in its place, if one is set
idtext
The entity's ID
modified_attext
When it last changed (ISO 8601)
nametext
Its name as Addepar shows it: its display name, or its name
original_nametext
Its name
ownership_typetext
How it is owned: PERCENT_BASED, SHARE_BASED or VALUE_BASED; empty for a client
typetext
Its type, as Addepar stores it, such as PERSON_NODE
type_nametext
Its type as Addepar's app names it, such as Client
Example output
{
  "attributes": {
    "is_rolled_up": false
  },
  "created_at": "2023-07-28T02:24:30Z",
  "currency": "USD",
  "display_name": "Citco",
  "id": "1000002",
  "modified_at": "2023-07-30T10:43:21Z",
  "name": "Citco",
  "original_name": "X092849032",
  "ownership_type": "PERCENT_BASED",
  "type": "FINANCIAL_ACCOUNT",
  "type_name": "Holding account"
}

Get group

Get a group's details, with the IDs of its members and of the groups inside it.

Inputs

GroupgrouptextRequired
The group's ID, a number such as 1000002, from another Addepar step or the trigger.

Outputs

attributesobject
Its other attributes, by their API field name
child_group_idslist
The IDs of the groups inside it
created_attext
When it was added (ISO 8601)
group_typetext
Its group type, such as GROUPS
idtext
The group's ID
member_idslist
The entity IDs of its members
modified_attext
When it last changed (ISO 8601)
nametext
Its name
Example output
{
  "attributes": {},
  "child_group_ids": [
    "6"
  ],
  "created_at": "2023-07-28T02:24:30Z",
  "group_type": "GROUPS",
  "id": "5",
  "member_ids": [
    "22",
    "24",
    "117"
  ],
  "modified_at": "2023-07-30T10:43:21Z",
  "name": "Group 1"
}

Get portfolio job

Pick up the results of a portfolio view or query run in the background, waiting until Addepar has finished it. Addepar keeps results for 24 hours.

Inputs

JobjobtextRequired
The job's ID, from 'Run portfolio view' or 'Run portfolio query' run in the background.
Wait for itwaittrue/false
On unless turned off. Off, the step hands on how far along the job is straight away.

Outputs

columnslist
The columns, in order
groupingslist
The groupings, outermost first
job_idtext
The job Addepar ran it as; empty when it ran straight away
row_countnumber
How many rows the results hold in all
rowslist
Each grouping's values, outermost first, each followed by those inside it
statustext
Completed, or how far along the job is, such as In Progress
totalobject
The whole portfolio's value in each column, by column key
truncatedtrue/false
True if there were more rows than a step hands on (2,000)
Example output
{
  "columns": [
    {
      "currency": "USD",
      "key": "value",
      "name": "Value (USD)",
      "output_type": "Number"
    }
  ],
  "groupings": [
    {
      "key": "holding_account",
      "name": "Holding Account"
    },
    {
      "key": "position",
      "name": "Position"
    }
  ],
  "job_id": "b6c1b9da-4387-11ef-8636-dd826f8aeed1a",
  "row_count": 2,
  "rows": [
    {
      "depth": 1,
      "grouping": "holding_account",
      "name": "Directly Owned",
      "path": "Directly Owned",
      "values": {
        "value": 10375354.56
      }
    },
    {
      "depth": 2,
      "grouping": "position",
      "name": "GS Liquidity Partners 2007 LP",
      "path": "Directly Owned > GS Liquidity Partners 2007 LP",
      "values": {
        "value": 8629166.56
      }
    }
  ],
  "status": "Completed",
  "total": {
    "value": 10375354.56
  },
  "truncated": false
}

Get transaction

Get a transaction's details, with the entities it is between.

Inputs

TransactiontransactiontextRequired
The transaction's ID, a number such as 1000002, from another Addepar step or the trigger.

Outputs

amountnumber
Its gross amount; 0 if not set
attributesobject
Its other fields, by their API name
base_valuenumber
Its value in the firm's currency, as Addepar works it out
cancelledtrue/false
True if it was cancelled, which keeps it out of balances
cash_position_idtext
The cash position it is paid to or from; empty if none
commenttext
Your firm's note on it
created_attext
When it was added (ISO 8601)
currencytext
Its currency, such as USD
descriptiontext
The custodian's description
feenumber
Its fees; 0 if none
idtext
The transaction's ID
modified_attext
When it last changed (ISO 8601)
owned_idtext
The investment or account it is in
owner_idtext
The entity that holds it, such as an account; empty for none
posted_datetext
The day the custodian reported it; empty if not set
settlement_datetext
The day it settles; empty if not set
tagslist
Its tags
trade_datetext
The day it happened (YYYY-MM-DD)
typetext
Its type, as Addepar stores it, such as buy
type_nametext
Its type in words, such as Buy
unitsnumber
How many shares or units; 0 if not set
Example output
{
  "amount": 0,
  "attributes": {
    "calculation_date": "2025-05-15"
  },
  "base_value": 10000,
  "cancelled": false,
  "cash_position_id": "315",
  "comment": "Random comment",
  "created_at": "",
  "currency": "USD",
  "description": "",
  "fee": 0,
  "id": "1967",
  "modified_at": "",
  "owned_id": "199",
  "owner_id": "196",
  "posted_date": "",
  "settlement_date": "",
  "tags": [
    "Unknown"
  ],
  "trade_date": "2019-01-02",
  "type": "buy",
  "type_name": "Buy",
  "units": 100
}

List saved views

List the saved analysis views you can run with 'Run portfolio view', such as to run each of them in turn.

Inputs

None.

Outputs

countnumber
How many are listed
viewslist
The saved views
Example output
{
  "count": 2,
  "views": [
    {
      "id": "2",
      "name": "owner1",
      "share_type": "FIRM"
    },
    {
      "id": "4",
      "name": "TOTAL RETURN VIEW",
      "share_type": "PORTAL"
    }
  ]
}

Run portfolio query

Get chosen columns, such as value or time weighted return, for a client, account, group or the whole firm over a period, grouped as you choose, such as by asset class.

Inputs

ColumnscolumnslistRequired
What to show, such as Value or TWR.
Group bygroupingslist
How to break it down, such as Asset Class, outermost first. Leave blank for the total alone.
Run it onportfolio_typetext
Which portfolio. Leave blank for a client, account or other entity.One of: ENTITY (A client, account or other entity), GROUP (A group), FIRM (The whole firm), FIRM_CLIENTS (Every client), FIRM_ACCOUNTS (Every account), FIRM_HOUSEHOLDS (Every household), FIRM_UNVERIFIED_ACCOUNTS (Every unverified account). Default: ENTITY.
Portfolioportfoliotext
The entity or group's ID, such as 1000002. Give several, separated by commas, to run it on them together. Needed for a client, account or group.Only when Run it on is A client, account or other entity or A group.
Start datestart_datedate
The first day of the period. Leave blank for the end date, for a view of a single day such as current holdings.
End dateend_datedate
The last day of the period. Leave blank for today.
Hide previous holdingshide_previous_holdingstrue/false
Turn on to leave out holdings no longer held at the end date.
In the backgroundin_backgroundtrue/false
Turn on for a big portfolio, such as the whole firm. Addepar prepares it as a job; this step waits up to about 45 seconds, then hands on the job's ID for 'Get portfolio job' to pick up the results.

Outputs

columnslist
The columns, in order
groupingslist
The groupings, outermost first
job_idtext
The job Addepar ran it as; empty when it ran straight away
row_countnumber
How many rows the results hold in all
rowslist
Each grouping's values, outermost first, each followed by those inside it
statustext
Completed, or how far along the job is, such as In Progress
totalobject
The whole portfolio's value in each column, by column key
truncatedtrue/false
True if there were more rows than a step hands on (2,000)
Example output
{
  "columns": [
    {
      "currency": "USD",
      "key": "value",
      "name": "Value (USD)",
      "output_type": "Number"
    }
  ],
  "groupings": [
    {
      "key": "holding_account",
      "name": "Holding Account"
    },
    {
      "key": "position",
      "name": "Position"
    }
  ],
  "job_id": "",
  "row_count": 2,
  "rows": [
    {
      "depth": 1,
      "grouping": "holding_account",
      "name": "Directly Owned",
      "path": "Directly Owned",
      "values": {
        "value": 10375354.56
      }
    },
    {
      "depth": 2,
      "grouping": "position",
      "name": "GS Liquidity Partners 2007 LP",
      "path": "Directly Owned > GS Liquidity Partners 2007 LP",
      "values": {
        "value": 8629166.56
      }
    }
  ],
  "status": "Completed",
  "total": {
    "value": 10375354.56
  },
  "truncated": false
}

Run portfolio view

Run a saved analysis view on a client, account, group or the whole firm for a period, and get its values as rows. Advanced and pivot tables can't be read this way.

Inputs

ViewviewtextRequired
The saved view to run, or its ID.
Run it onportfolio_typetext
Which portfolio. Leave blank for a client, account or other entity.One of: ENTITY (A client, account or other entity), GROUP (A group), FIRM (The whole firm), FIRM_CLIENTS (Every client), FIRM_ACCOUNTS (Every account), FIRM_HOUSEHOLDS (Every household), FIRM_UNVERIFIED_ACCOUNTS (Every unverified account). Default: ENTITY.
Portfolioportfoliotext
The entity or group's ID, such as 1000002. Needed for a client, account or group.Only when Run it on is A client, account or other entity or A group.
Start datestart_datedate
The first day of the period. Leave blank for the end date, for a view of a single day such as current holdings.
End dateend_datedate
The last day of the period. Leave blank for today.
In the backgroundin_backgroundtrue/false
Turn on for a big portfolio, such as the whole firm. Addepar prepares it as a job; this step waits up to about 45 seconds, then hands on the job's ID for 'Get portfolio job' to pick up the results.

Outputs

columnslist
The columns, in order
groupingslist
The groupings, outermost first
job_idtext
The job Addepar ran it as; empty when it ran straight away
row_countnumber
How many rows the results hold in all
rowslist
Each grouping's values, outermost first, each followed by those inside it
statustext
Completed, or how far along the job is, such as In Progress
totalobject
The whole portfolio's value in each column, by column key
truncatedtrue/false
True if there were more rows than a step hands on (2,000)
Example output
{
  "columns": [
    {
      "currency": "USD",
      "key": "value",
      "name": "Value (USD)",
      "output_type": "Number"
    }
  ],
  "groupings": [
    {
      "key": "holding_account",
      "name": "Holding Account"
    },
    {
      "key": "position",
      "name": "Position"
    }
  ],
  "job_id": "",
  "row_count": 2,
  "rows": [
    {
      "depth": 1,
      "grouping": "holding_account",
      "name": "Directly Owned",
      "path": "Directly Owned",
      "values": {
        "value": 10375354.56
      }
    },
    {
      "depth": 2,
      "grouping": "position",
      "name": "GS Liquidity Partners 2007 LP",
      "path": "Directly Owned > GS Liquidity Partners 2007 LP",
      "values": {
        "value": 8629166.56
      }
    }
  ],
  "status": "Completed",
  "total": {
    "value": 10375354.56
  },
  "truncated": false
}

Update contact

Change a contact's details, or affiliate them with more clients or groups. Fields left blank keep what they have.

Inputs

ContactcontacttextRequired
The contact's ID, a number such as 1000002, from another Addepar step or the trigger.
First namefirst_nametext
Their first name, up to 40 characters. Leave blank to keep it.
Last namelast_nametext
Their last name, up to 80 characters. Leave blank to keep it.
Emailemailtext
An email for them. It replaces their email of the same type.
Email typeemail_typetext
What kind of email it is. Leave blank for work.One of: WORK, PERSONAL, FAMILY, OTHER. Default: WORK.
Phonephonetext
A phone number, up to 15 characters, such as 9179999999. It replaces their number of the same type.
Phone typephone_typetext
What kind of number it is. Leave blank for mobile.One of: CELL (Mobile), WORK, HOME, FAX, OTHER. Default: CELL.
Client Portal emaillogin_emailtext
The email they would sign in to the Client Portal with. Leave blank to keep it.
Titletitletext
Their title, such as Mr. or Dr. Leave blank to keep it.
Suffixsuffixtext
Their suffix, such as Jr. Leave blank to keep it.
Employeremployertext
Who they work for. Leave blank to keep it.
Occupationoccupationtext
What they do. Leave blank to keep it.
Birthdaybirthdaydate
Their date of birth. Leave blank to keep it.
Your ID for themexternal_user_idtext
Your firm's own ID for them, such as their ID in your CRM, up to 31 characters. Leave blank to keep it.
Add entitiesadd_entitieslist
The IDs of more clients or other entities to affiliate them with.
Add groupsadd_groupslist
The IDs of more groups to affiliate them with.

Outputs

birthdaytext
Their birthday (YYYY-MM-DD)
emailtext
Their first email
emailslist
All their emails
employertext
Their employer
entity_idslist
The entities they are affiliated with
external_user_idtext
Your firm's own ID for them
first_nametext
Their first name
group_idslist
The groups they are affiliated with
idtext
The contact's ID
last_nametext
Their last name
login_emailtext
The email they sign in to the Client Portal with
mailing_addresseslist
Their mailing addresses
nametext
Their full name
occupationtext
Their occupation
phonetext
Their first phone number
phone_numberslist
All their phone numbers
portal_accesstext
Their Client Portal access, such as deactivated
suffixtext
Their suffix, such as Jr.
titletext
Their title, such as Mr.
Example output
{
  "birthday": "1990-10-31",
  "email": "example@addepar.com",
  "emails": [
    {
      "email": "example@addepar.com",
      "type": "WORK"
    }
  ],
  "employer": "Addepar",
  "entity_ids": [
    "22"
  ],
  "external_user_id": "abc123",
  "first_name": "Adam",
  "group_ids": [],
  "id": "2000",
  "last_name": "Smith",
  "login_email": "adam.smith@example.com",
  "mailing_addresses": [
    {
      "city": "New York",
      "country": "United States",
      "state": "New York",
      "street": "335 Madison Ave",
      "street2": "25th Floor",
      "type": "Work",
      "zip": "10017"
    }
  ],
  "name": "Adam Smith",
  "occupation": "Financial Services",
  "phone": "0987654321",
  "phone_numbers": [
    {
      "number": "0987654321",
      "type": "WORK"
    }
  ],
  "portal_access": "deactivated",
  "suffix": "Jr.",
  "title": "Mr."
}

Update entity

Change an entity's name, display name, currency or other attributes. Fields left blank keep what they have.

Inputs

EntityentitytextRequired
The entity's ID, a number such as 1000002, from another Addepar step or the trigger.
Namenametext
A new name. Leave blank to keep it.
Display namedisplay_nametext
A new name to show in its place. Leave blank to keep it.
Currencycurrencytext
A new currency. Leave blank to keep it.
Other attributesattributesobject
Other attributes by their API field name, such as {"asset_class": "Equity"}. An attribute's API field name is under Firm Administration > Attributes in Addepar.

Outputs

attributesobject
Its other attributes, by their API field name
created_attext
When it was added (ISO 8601)
currencytext
Its currency, such as USD
display_nametext
The name shown in its place, if one is set
idtext
The entity's ID
modified_attext
When it last changed (ISO 8601)
nametext
Its name as Addepar shows it: its display name, or its name
original_nametext
Its name
ownership_typetext
How it is owned: PERCENT_BASED, SHARE_BASED or VALUE_BASED; empty for a client
typetext
Its type, as Addepar stores it, such as PERSON_NODE
type_nametext
Its type as Addepar's app names it, such as Client
Example output
{
  "attributes": {
    "is_rolled_up": false
  },
  "created_at": "2023-07-28T02:24:30Z",
  "currency": "USD",
  "display_name": "Citco",
  "id": "1000002",
  "modified_at": "2023-07-30T10:43:21Z",
  "name": "Citco",
  "original_name": "X092849032",
  "ownership_type": "PERCENT_BASED",
  "type": "FINANCIAL_ACCOUNT",
  "type_name": "Holding account"
}

Update group

Rename a group, add members to it or take members out. Give at least one.

Inputs

GroupgrouptextRequired
The group's ID, a number such as 1000002, from another Addepar step or the trigger.
Namenametext
A new name. Leave blank to keep it.
Add membersadd_memberslist
The entity IDs to add to the group.
Take out membersremove_memberslist
The entity IDs to take out of the group. They stay in Addepar.

Outputs

attributesobject
Its other attributes, by their API field name
child_group_idslist
The IDs of the groups inside it
created_attext
When it was added (ISO 8601)
group_typetext
Its group type, such as GROUPS
idtext
The group's ID
member_idslist
The entity IDs of its members
modified_attext
When it last changed (ISO 8601)
nametext
Its name
Example output
{
  "attributes": {},
  "child_group_ids": [
    "6"
  ],
  "created_at": "2023-07-28T02:24:30Z",
  "group_type": "GROUPS",
  "id": "5",
  "member_ids": [
    "22",
    "24",
    "117"
  ],
  "modified_at": "2023-07-30T10:43:21Z",
  "name": "Group 1"
}

Upload file

Upload a file to Addepar's file vault, such as a statement, linked to the clients or groups it's about. Give a file, or text to save as one.

Inputs

Filefiletext
The file: upload one, pick one from an earlier step, or give a public https link to it.
Texttexttext
Text to save as a file instead, such as notes or CSV.
File namenametext
What to call it, with its extension, such as Statement.pdf. Leave blank to keep the file's own name.
Folderfoldertext
The folder's ID, a number such as 1000002, from another Addepar step or the trigger. The folder to put it in. Leave blank for the top.
Entitiesentitieslist
The IDs of the clients or other entities it's about.
Groupsgroupslist
The IDs of the groups it's about.

Outputs

bytesnumber
Its size in bytes
content_typetext
What kind of file it is, such as application/PDF
created_attext
When it was added (ISO 8601)
entity_idslist
The entities it is linked to
group_idslist
The groups it is linked to
idtext
The file's ID
is_foldertrue/false
True for a folder
modified_attext
When it last changed (ISO 8601)
nametext
Its name, with its extension
parent_folder_idtext
The folder it is in; empty or 0 at the top
Example output
{
  "bytes": 256201,
  "content_type": "application/PDF",
  "created_at": "2014-06-20T20:55:07Z",
  "entity_ids": [
    "10000",
    "10001"
  ],
  "group_ids": [
    "1234",
    "5678"
  ],
  "id": "123",
  "is_folder": false,
  "modified_at": "",
  "name": "Sample.pdf",
  "parent_folder_id": ""
}

On this page