When wanting to return every available item of a given entity
type you can statically call the all method on supported entities:
Expected arguments:
| Key | Required | Type | Description |
|---|---|---|---|
query |
false | string | A fuzzy search to filter down entities |
after |
false | timestamp | A Unix timestamp to list entities updated after |
page |
false | int | The page number to load the current results from |
perPage |
false | int | The number of results per page to fetch. Defaults to 15 and is limited to 100 |
When a page is passed then an array is returned. The first element being the current
dataset and the second element being the last page.
If no page is passed then the library loops through all available pages and returns
the whole collected dataset at the end.