b2evolution b2evolution

  • Sign in
  • Sign up
  • About
  • Downloads
  • Hosting
  • Docs
  • Support
  • Sign in
  • Sign up
  • Manuals Home
  • Latest Updates
 
  1. b2evolution CMS User Manual
  2. Advanced Topics
  3. Using the APIs
  4. REST API or RESTful API
  5. List Collections (REST)

List Collections (REST)

GET <baseurl>/api/v1/collections

Parameters

Possible request params

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 below.

fields

string

What collection fields use to search by param q.
Possible values: id, shortname.

shortname

list_in_frontoffice

string

Filter collections by possible values:

  • all - Load all collections that can be seen by currently logged in User (based on their Allow access to setting).
  • public - Load only collections that are listed publicly (based on their Show in Front-office list setting).

public

restrict_to_available_fileroots

integer

Possible values: 1 - Load ONLY the collections with available file roots to view by the current user

0

Response

Response is an array of the following properties:

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

Name

Type

Description

id

integer

Collection ID

urlname

string

Short string to be used in URLs

kind

string

main / std / photo / group / forum / manual

shortname

string

Short string to be used menus

name

string

Full name of the collection

tagline

string

Tagline

desc

string

Long Description

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
Created by yurabakhtin • Last edit by yurabakhtin on 2019-09-11 14:44 • •

No feedback yet

On this page

  • Parameters
  • Response
  • Used for:

Search the Manual

Content Hierarchy

  • b2evolution CMS User Manual
  • User's Guide
  • Installation / Upgrade
  • Front-office Reference
  • Back-office Reference
  • Developer Reference
  • Operations Reference
  • Advanced Topics
    • Using Desktop Blogging Tools
    • Using Blogging Apps
    • Blogging by email
    • Using the APIs
      • REST API or RESTful API
        • List Collections (REST)
        • List Posts (REST)
        • List Items (REST)
        • Retrieve a Post (REST)
        • Retrieve any item (REST)
        • Search (REST)
        • List Users (REST)
        • Retrieve a User (REST)
        • Create a User (REST)
        • Update a User (REST)
        • Delete a User (REST)
        • Cookie Authentication (REST)
        • Basic HTTP Authentication (REST)
      • B2 API
      • API Error Codes
      • Blogger API
      • MetaWeblog API
      • MovableType API
    • Contributing
    • Translations (i18n/l10n)
    • Monetizing
    • How to...
    • Podcasting
  • Glossary
  • Archives
Run your own website!

This online manual is powered by b2evolution CMS – A complete engine for your website.

About b2evolution

  • What is it?
  • Features
  • Getting Started
  • Screenshots
  • Online demo
  • Testimonials
  • Design philosophy
  • Free & open source
  • Terms of service

Downloads

  • Latest releases
  • Skins
  • Plugins
  • Language packs

About us

  • About us
  • Contact

Webhosting Guide

  • Web hosting blog
  • Best web hosting
  • Cheap web hosting
  • Green web hosting
  • Hosting with SSH
  • VPS hosting
  • Dedicated servers
  • Reseller hosting
  • Int'l: UK / France

Docs & Support

  • Online manual
  • Forums
  • Hire a pro !

Other

  • Adsense
  • Press room
  • Privacy policy

Stay in touch

  • GitHub
  • Twitter
  • Facebook
  • LinkedIn
  • News blog
  • RSS feed
  • Atom feed

Founded & Maintained by François Planque