Overview

UserEcho provides an API that lets you perform all the operations available to users and admins via WEB interface and more.

API consists of the Base API and Advanced API. Base API - allows read access to data. currently in development, will give you access to create and maintain objects.

Requests format

All calls to the API must be made at:
http://userecho.com/api/

Typical call format is:
http://userecho.com/api/[command].[format]?key=[api_key]
where:
[command] - any of the supported commands from list below.
[format] - output format. We support json, xml and csv.
[api_key] - Your API key. You can get key under Setup->Advanced features->API.

You should replace the [user_id],[feedback_id],[forum_id],... with suitable values

Types of responses

We support JSON, XML and CSV responce format at this time. Feel free to request what's you need at our support forum. Replace [format] with json, xml or csv.

Common params

We support pagination in all requests. By default all queries limited to 50 records.
For pagination we use two params.
page - select page
limit - limit records on page

Sample request

Let's suppose than we need get users of your support forum.
http://userecho.com/api/users.json?key=[replace with your key] - return all users. http://userecho.com/api/users.json?page=11&limit=2&key=[replace with your key] - return 11th page of user list

[
    {
        "first_name": "D C", 
        "is_staff": false, 
        "last_login": "2010-03-04 09:42:23", 
        "id": 171, 
        "date_joined": "2010-03-04 09:42:23"
    }, 
    {
        "first_name": "carlopires", 
        "is_staff": false, 
        "last_login": "2010-04-09 16:21:04", 
        "id": 175, 
        "date_joined": "2010-03-04 15:34:58"
    }
]

For more detail look at API reference.