Home > @uniformdev/canvas > CanvasClient > getCompositionList
CanvasClient.getCompositionList() method
Fetches lists of Canvas compositions, optionally by type
Signature:
getCompositionList(params?: Omit<CompositionGetParameters, 'projectId' | 'componentId' | 'compositionId' | 'slug'> & {
filters?: CompositionFilters;
} & ({
resolveData: true;
diagnostics?: boolean;
} | {
resolveData?: false;
})): Promise<CompositionGetListResponse | CompositionResolvedListResponse>;
Parameters
| Parameter | Type | Description |
|---|---|---|
| params | Omit<CompositionGetParameters; } & ({ resolveData: true; diagnostics?: boolean; } | { resolveData?: false; }) | (Optional) |
Returns:
Promise<CompositionGetListResponse | CompositionResolvedListResponse>