# Get all new business events

**GET /api/v1/new-business-event**

This endpoint will return all new business events 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
- **filter[uuid]** (string)
  Filter by a comma separated list of UUIDs.
- **filter[account_uuids]** (string)
  Filter by a comma separated list of account UUIDs.
- **filter[group_uuids]** (string)
  Filter by a comma separated list of group UUIDs.
- **filter[plan_uuids]** (string)
  Filter by a comma separated list of plan UUIDs.
- **filter[case_uuids]** (string)
  Filter by a comma separated list of case UUIDs.
- **filter[adviser_uuids]** (string)
  Filter by a comma separated list of Adviser (account) UUIDs.
- **filter[existing_plan_uuids]** (string)
  Filter by a comma separated list of Existing Plan UUIDs.
- **filter[circle_uuids]** (string)
  Filter by a comma separated list of circle UUIDs.
- **filter[type]** (string)
  Plan type to filter by.
- **filter[sub_type]** (string)
  Plan sub type to filter by.
- **filter[provider_uuid]** (string)
  Plan's provider UUID to filter by.
- **filter[policy_number]** (string)
  Fuzzy search for plan policy number.
- **filter[advice_type]** (string)
  Exact search for an advice type.
- **filter[conducted_by]** (string)
  Exact search for how the advice was conducted.
- **filter[status]** (string)
  Current status of the event.
- **filter[source_of_funds]** (string)
  Exact search for source of funds.
- **filter[is_replacing_existing_plan]** (boolean)
  Whether the plan is replacing an existing plan.
- **filter[opted_out_of_pension_scheme_for_plan]** (boolean)
  Whether the client opted out of pension scheme for the plan.
- **filter[date_from]** (string)
  Started after this date.
- **filter[date_to]** (string)
  Started before this date.
- **filter[proposed_date_from]** (string)
  Proposed after this date.
- **filter[proposed_date_to]** (string)
  Proposed before this date.
- **filter[created_from]** (string)
  Created after this date.
- **filter[created_to]** (string)
  Created before this date.
- **filter[updated_from]** (string)
  Updated after this date.
- **filter[updated_to]** (string)
  Updated before this date.
- **filter[contribution_type]** (string)
  Exact search for the contribution type.
- **include** (string)
  Comma separated list of relationships to include in the response. Valid relationships are [existing_plan].
- **sort** (string)
  Field to sort by. Valid fields are [start_date, proposal_date, created_at, updated_at]. Negative sign to denote DESC.  Defaults to '-start_date'.
- **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)