# Get all plans

**GET /api/v2/plans**

This endpoint will return all plans in the firm relevant to the user accessing them.


## Servers
- https://api.plannrcrm.com: https://api.plannrcrm.com ()


## Authentication methods
- Personal access token & O auth2


## Parameters
### Headers
- **X-PLANNR-ACCOUNT-UUID** (string)



### Query parameters
- **date** (string)
  Date in format Y-m-d to get the plan's value at the date. Defaults to current date if not provided.
- **include_circle_plans** (boolean)
  When authenticated as a client, you can opt to include other plans belonging to members of circles the authenticated client is a member of as long as they have the correct circle circle login access level to do so.
- **include** (string)
  Comma separated list of relationships to include in the response. Valid relationships are [cases, tags, sub_accounts, wrap, wrap_children, wrap_children.provider, external_references, active_adviser, seller, linked_owners, group_scheme, sub_group_scheme, custom_fields].
- **filter[uuid]** (string)
  Filter by a comma separated list of UUIDs.
- **filter[abstract_type]** (string)
  Comma separated list of abstract types.  Valid abstract types are [asset, liability, protection]
- **filter[type]** (string)
  Comma separated list of types.  Valid abstract types are [cash_account, investment, protection_policy, pension, annuity, general_insurance, group_protection, mortgage, loan_credit, fixed_asset]
- **filter[sub_type]** (string)
  Comma separated list of sub types.
- **filter[name]** (string)
  Comma separated list of plan names to search against, can include partial matches.
- **filter[account_uuids]** (string)
  Comma separated list of client UUIDs to search against.
- **filter[exact_account_uuids]** (string)
  Comma separated list of accounts UUIDs that are all the owners of a plan.
- **filter[circle_uuids]** (string)
  Comma separated list of circle UUIDs to search against.
- **filter[policy_number]** (string)
  Comma separated list of policy numbers to search against, can include partial matches.
- **filter[provider_uuids]** (string)
  Comma separated list of provider provider UUIDs to search against.
- **filter[status]** (string)
  Comma separated string of statuses to filter by. Valid statuses are [active, proposed, inactive]
- **filter[seller_uuids]** (string)
  Comma separated list of adviser UUIDs of who sold the plan to search against.
- **filter[active_adviser_uuids]** (string)
  Comma separated list of adviser UUIDs of who is actively managing the plan to search against.
- **filter[case_uuids]** (string)
  Comma separated list of case UUIDs
- **filter[valuation_from]** (integer)
  Amount in pennies to filter where latest valuation is greater than.
- **filter[valuation_to]** (integer)
  Amount in pennies to filter where latest valuation is less than.
- **filter[custom_field:REFERENCE]** (string)
  Filter by a plan custom field. Example filter[custom_field:cryptocurrencies]=bitcoin
- **filter[tags]** (string)
  Comma separated list of tag names or tag UUIDs.
- **filter[is_wrap_product]** (boolean)
  filter the plans by if they are a wrap product
- **filter[hide_wrap_children]** (boolean)
  Used to hide the wrap children from the primary list of plans.
- **sort** (string)
  Field to sort by. Valid fields are [created_at, updated_at, name, type, value]. Negative sign to denote DESC. Defaults to 'name'.
- **per_page** (integer)
  Number of results to return with pagination (Default 15. Max 500).


## Responses
### 200


#### Body: application/json (object)
- **data** (array[object])



[Powered by Bump.sh](https://bump.sh)