blog

integer

ID of the collection to be displayed.
This is for RSS generation mainly.
In the front-office, the ID of the collection to be displayed will generally be determined by the URL.

Web only

posts

integer

Number of items/posts or days (depending on "unit") to display on the page

Depends on collection setting Posts/Days per page

Web + API

unit

string

What unit use to pagination: ‘posts’ or ‘days’

Depends on collection setting Display unit

Web + API

cat

integer / string

• Category ID: selects posts from that category as well as its sub-categories
• Comma separated list of category IDs: selects posts from all listed categories and their sub-categories
• Starting the list with a minus (-) will select posts from all categories but the listed ones. Items that belong to any other non-hidden category, will be shown when display that particular category. i.e. If an item "X" belongs to categories "A" and "B", and "A" is affected by the minus (-) operator, but "B" is not, then the inheritance of category "B" will take effect and item "X" is shown.
• Starting the list with an asterisk (*) will select posts which are categorized simultaneously in ALL listed categories.
• This parameter can be just - or * if you combine it with [b]catsel[/b] below.

Web + API

catsel%5B%5D

array

• If this was unencoded it would actually read catsel[] . Think this is a joke? Actually yes, PHP sometimes feels like a joke! This is the normal way of passing multiple values for a parameter in PHP!
• This parameter can appear several times with a different category ID each. All the IDs will add up to the category list (except if exclusion mode is used)
• The difference with the cat param is that with catsel you only select the specific category but you don’t select its sub-categories.
• the variable equivalent is $catsel[] =

Web + API

tag

string

Tag name, or several tags separated by comma

Web + API

author

integer / string

• Author ID: selects posts from that author only
• Comma separated list of author ID: selects posts from all listed authors only
• Starting the list with a minus (-) will select posts from all authors except the listed ones

Web + API

author_login

string

• Author login: selects posts from that author only
• Comma separated list of author login: selects posts from all listed authors only
• Starting the list with a minus (-) will select posts from all authors except the listed ones

Web + API

assgn

integer / string

• Use when workflow feature is enabled for the collection
• User ID of post assignee: selects posts from that assignee only
• Comma separated list of assignee ID: selects posts from all listed assignees only
• Starting the list with a minus (-) will select posts from all assignees except the listed ones

Web + API

assgn_login

string

• Use when workflow feature is enabled for the collection
• User login of post assignee: selects posts from that assignee only
• Comma separated list of assignee login: selects posts from all listed assignees only
• Starting the list with a minus (-) will select posts from all assignees except the listed ones

Web + API

author_assignee

integer

User ID of post author or assignee: selects posts from that author or assignee only

Web + API

lc

string

Post locale. Examples:

• lc=en returns all posts with locale en-US, en-GB, en-SG.
• lc=en-US returns only the posts with locale en-US.

all

Web + API

status

string

• Use when workflow feature is enabled for the collection
• Task status ID: selects posts with that status only
• Comma separated list of status ID: selects posts with all listed statuses only
• Starting the list with a minus (-) will select posts with all statuses except the listed ones

Web + API

types

string

• Post type ID: selects posts with that types only
• Comma separated list of type ID: selects posts with all listed types only
• Starting the list with a minus (-) will select posts with all types except the listed ones

Web + API

s

string

Search string: sentence or words (separate with spaces or commas) to be searched in the post fields(see param scope)

Web + API

scope

string

The post fields that are used for searching

title,content

Web + API

sentence

string

Search for sentence or for words. Available values:

• AND: search for words, combining them with AND (default)
• OR: search for words, combining them with OR
• sentence or 1: search for whole sentence to be used in conjunction with param s

AND

Web + API

exact

integer

1 - Use exact match for searching, 0 - Find the words as part of the fields

0

Web + API

p

integer

Get single post by ID

Web + API

page

integer

Page number in multipage post

1

Web only

title

string

Get single post by urltitle

Web + API

pl

integer / string

• Comma separated list of post IDs
• Starting the list with a minus (-) will select posts except the listed ones

Web + API

m

string

Filter posts by date:

• yyyy: display specific year
• yyyymm: display specific month mm of year yyyy
• yyyymmdd: display specific day
• yyyymmddhh: hour
• yyyymmddhhmm: hour minute
• yyyymmddhhmmss: hour minute second

Web + API

w

integer

Week number of current selected year:

• Display posts of that week (to be used in conjunction with param m for the year)
• Note: b2evo uses MySQL’s week numbering and MySQL default if applicable.
• In MySQL < 4.0.14, WEEK() always uses mode 0: Week starts on Sunday.
• Value range is 0 to 53; week 1 is the first week that starts in this year.
• See MySQL manual.

Web + API

dstart

string

Filter posts by start date:

• yyyy: display specific year
• yyyymm: display specific month mm of year yyyy
• yyyymmdd: display specific day
• yyyymmddhh: hour
• yyyymmddhhmm: hour minute
• yyyymmddhhmmss: hour minute second

Web + API

dstop

string

Filter posts by stop date:

• yyyy: display specific year
• yyyymm: display specific month mm of year yyyy
• yyyymmdd: display specific day
• yyyymmddhh: hour
• yyyymmddhhmm: hour minute
• yyyymmddhhmmss: hour minute second

Web + API

show_statuses%5B%5D

array

Post statuses: ‘published’, ‘community’, ‘deprecated’, ‘protected’, ‘private’, ‘review’, ‘draft’, ‘redirected’.

All post statuses that are available for current user

Web + API

orderby

string

List of post fields to order by, separated by space or comma (requires some knowledge of the database):

• datestart: Date issued
• order: Order (as explicitly specified)
• title: Title
• datecreated: Date created
• datemodified: Date last modified
• last_touched_ts: Date last touched
• urltitle: URL "filename"
• priority: Priority
• views: Views
• RAND: Random order
• creator_user_ID: Author ID

Depending on collection setting Order by

Web + API

order

string

Order direction:

• ASC: ascending/chronological
• DESC: descending/reverse chronological

Depending on collection setting Direction

Web + API