LiveWhale Calendar

Welcome, Guest Login

Support Center

REST URL Structure

Last Updated: Jun 25, 2014 03:33PM PDT

To obtain lists of items from your LiveWhale, make a request to the API via a REST URL. Use the following format:[live]/[format]/[content-type]/[parameters]/


To access an individual content item, use the following format:[live]/[content-type]/[id][@FORMAT]



Almost all LiveWhale instances use the default /live/ API path, but you can configure an alternate path if /live/ is unavailable.

[format or @FORMAT]

The format represents the format in which you wish the content returned. Available formats are:

  • /rss/
  • /ical/
  • /json/

When appended to an individual item request, valid values are:

  • @JSON
  • @XML


The content type represents the LiveWhale content you wish returned. Available types are:

  • /pages/
  • /news/
  • /events/
  • /galleries/
  • /forms/
  • /blurbs/
  • /profiles/
  • /images/
  • /files/
  • /places/


The parameters refine the content, ordering and range. Here are some helpful formats to remember:

  • They are always paired and there is always a terminal slash.
  • Where a string is used, it should be URL encoded, e.g. /group/LiveWhale%20Staff/.
  • Booleans appear as strings, e.g. /true/ or /false/.
  • Not all parameters work with all formats or with all content types, as they may not apply. (For example, only events have categories.)


This is the integer id of the content item desired.

Continuing in this topic: RSS and iCal

Expertise Needed: Editor

Software: LiveWhale CMS, LiveWhale One, LiveWhale Calendar

Version Applicability: Current

SFTP Access Required? No
seconds ago
a minute ago
minutes ago
an hour ago
hours ago
a day ago
days ago
Invalid characters found