API Query Variables

All API calls should include a POST request. This request requires at minimum an account API Key.

Basic Query Variables

Variable Description
api_key A valid account API key.
bin_id The Content Bin ID you want to access.
item_id Reference a specific item by it's ID.
limit Limit the number of items returned. (This is set to 100 by default).
start Start the result set at a specific index. Example: "limit=10&start=9" would return items 10 - 20.
order_by Specify the order of results. By default, results will be ordered by according to the settings within the Content Bin you are accessing. Example: "order_by=title asc" will return items alphabetically by title, in ascending order.
active By default Osmek will only return items which are active. You can access inactive items with "active=0", or all items with "active=both"
search Search items by keyword.
search_in Search only in a specific field.
tags Find items by tag. This can be a single tag, or a list of tags seperated by commas. Preceeding a tag with and exclamation mark "!" will find items that do not include that tag. Grouping tags in hard brackets will find items matching 1 or more of the tags.

Examples:
"tags=news" would return items with the tag "news".
"tags=[news,new-features],!updates" would return items with either the tag "news" or "new-fetures", but not tagged "updates".

categories Find items by category. This can be a single category, or a list of categories seperated by commas. Preceeding a category with and exclamation mark "!" will find items that do not include that category. Grouping categories in hard brackets will find items matching 1 or more of the categories.

Examples:
"categories=news" would return items in the category "news".
"categories=[news,new-features],!updates" would return items in either the category "news" or "new-fetures", but not in "updates".

date, date_added, date_published, date_start, & date_end For date fields you can specify an exact date, or preceed a date with a greater than or less than sign.

Examples:
date=2012-05-25 or date_start=> 2012-05-25

date_range Find items in a specific date range. Can be "future", "past", or two dates seperated by a comma (Example: October 1st 2010,October 31st 2010).

date_range will affect the date added, or date published field. For an Events or Shows content bin, you can also specify date_start_range and date_end_range to access the start and end date fields.

date:year Find items in a specific year. Should be a 4 digit year. This works for date, date_added, date_published, date_start, & date_end fields.

Example: date_published:year=2010
date:month Find items in a specific month. Should be a 2 digit month. This works for date, date_added, date_published, date_start, & date_end fields.

Example: date_added:month=10
date:dayofmonth Find items in a day of the month. Should be a 2 digit day. This works for date, date_added, date_published, date_start, & date_end fields.

Example: date:dayofmonth=30&date:month=03
require_fields A list a fields seperated by commas which must contain a value. Example: require_fields=title,description
auto_link Automaitcally turn URLs into anchor tags. (Off by default).

Finding items with a particular value

You can match any field in a content bin by passing it's field name with a value. This applies to custom fields as well.

Example:
url_title=My-First-Post or my_custom_field=value

Bin specific queries

Photo Gallery

Variable Description
sheet If set to "albums" (default), the feed method will return a list of albums. If set to "photos", the feed method will return a list of photos.
album_id If sheet=photos, use album_id to specify the album you want
fill_albums If true (or 1), and sheet=albums, each album will include a photos array of it's images