[[ForgeBox:API-Documentation|<< Back to ForgeBox API Documentation]]


== ForgeBox API Method: entries ==
Returns code entries according to passed in parameters or using default values.

'''URL:'''
<pre>http://www.coldbox.org/api/forgebox/{format}/entries</pre>

'''Formats:'''
* xml
* json

'''HTTP Method(s):'''
* GET

'''Parameters:'''
* '''orderby''' (optional) : The ordering to impose in the results. Available order keywords are:
** ''New''
** ''Recent'' (Default)
** ''Popular''
* '''maxrows''' (optional) : The max records to retrieve. By default we return all records (defaults to 0)
* '''startrow''' (optional) : The offset to use when paging records.  By default we return all records (defaults to 0)
* '''type''' (optional) : The type slug to filter the results with.  You will need to use the ForgeBox type slugs in order to make this work. Please see the [[ForgeBox:types| types method]]

== Usage examples: ==
Below is a simple example using curl ([http://en.wikipedia.org/wiki/CURL/ about cURL])

* ''curl'' http://www.coldbox.org/api/forgebox/xml/entries
* ''curl'' http://www.coldbox.org/api/forgebox/xml/entries?maxrows=20&startrow=20
* ''curl'' http://www.coldbox.org/api/forgebox/xml/entries?orderby=popular
<br/><br/>

[[ForgeBox:API-Documentation|<< Back to ForgeBox API Documentation]]