# Get all the illustrations for a plan

**GET /api/v1/plans/{plan_uuid}/illustrations**




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


## Authentication methods
- Personal access token & O auth2


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


### Path parameters
- **plan_uuid** (string)


### Query parameters
- **include** (string)
  Comma separated list of relationships to include in the response. Valid relationships are [firm, client, plan, requestedBy].
- **filter[created_after]** (string)
  Illustration created after in format YYYY-MM-DD e.g. 2022-10-15
- **filter[created_before]** (string)
  Illustration created before in format YYYY-MM-DD e.g. 2022-12-30
- **filter[generated_after]** (string)
  Illustration generated after in format YYYY-MM-DD e.g. 2022-10-15
- **filter[generated_before]** (string)
  Illustration generated before in format YYYY-MM-DD e.g. 2022-12-30
- **filter[platform]** (string)
  Illustration platform.
- **filter[requested_by_uuid]** (string)
  Illustration requested by account uuid.
- **filter[name]** (string)
  Fuzzy search for Illustration name.
- **sort** (string)
  Field to sort by. Valid fields are [created_at, updated_at, generated_at]. Negative sign to denote DESC.  Defaults to '-created_at'.


## Responses
### 200


#### Body: application/json (object)
- **uuid** (string)
  The UUID of the resource.
- **created_at** (string)
  The timestamp of when the resource was created.
- **updated_at** (string)
  The timestamp of when the resource was updated.
- **generated_at** (string)
  The timestamp of when the illustration was generated with the platform.
- **status** (string)
  The status of the illustration. Available values: created, generating_illustration and generated_illustration
- **client** (object)
  The lead account that the illustration belongs to.
- **accounts** (array[object])
  The list of accounts that the illustration belongs to. This will include the lead account.
- **application** (object)
  If the illustration is linked to an application, this will be the application resource.
- **plan** (object)
  The plan that the illustration belongs to.
- **requested_by** (object)
  The account (adviser) that requested the illustration.
- **name** (string)
  The name of the illustration.
- **request_data** (array)
  The request data used to generate the illustration.
- **platform** (string)
  The platform used to generate the illustration.
- **platform_illustration_id** (string)
  The platform specific illustration id.
- **account_opening_allowed** (boolean)
  Whether the account opening is allowed for the illustration.
- **is_draft** (boolean)
  Whether the illustration is in the created/draft state.


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