- b2evolution CMS User Manual
- Advanced Topics
- Using the APIs
- REST API or RESTful API
- List Collections (REST)
List Collections (REST)
GET <baseurl>/api/v1/collections
Parameters
Name |
Type |
Description |
Default |
---|---|---|---|
page |
integer |
Page number |
1 |
per_page |
integer |
Number of results per page (0 for all results) |
10 |
q |
string |
Search string by collection fields, see a param |
|
fields |
string |
What collection fields use to search by param |
shortname |
list_in_frontoffice |
string |
Filter collections by possible values:
|
public |
restrict_to_available_fileroots |
integer |
Possible values: |
0 |
Response
Name |
Type |
Description |
||||||||||||||||||||||||
---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|
found |
integer |
Number of found collections |
||||||||||||||||||||||||
page |
integer |
Current page |
||||||||||||||||||||||||
page_size |
integer |
Number of collections per page |
||||||||||||||||||||||||
pages_total |
integer |
Number of total pages |
||||||||||||||||||||||||
colls |
array |
Array of collections list, see the properties in the table below
|
Used for:
- Search collections in modal window of file browser menu option "Collection roots -> Other…" in order to switch a selected collection File Root
- Display collections list in selector of modal window to merge posts
- Display collections list in selector of modal window to insert short link by Short Links / ForeverLinks / Quick Links Plugin