API Documentation

The REST API allows developers to hook into Clientexec and connect it to third-party applications.

API MENU

Get Users

  • GET /
  • accounts/users/

Arguments

Name Type Description
start int Where to start the paging from - defaults to 0
limit int Limit the number of users returned - defaults to 10
customsearchtype string Optional custom field search: c_package_field or c_profile_field
customsearchfield int Required if passing custom search params. Id of custom field.
customsearchstring string Required if passing custom search params. The value you are searching for

Example JSON Response

{
    "timestamp": 1391205164,
    "totalcount": 17433,
    "clients": [
        {
            "clienttype": 18,
            "id": 105,
            "firstname": "James",
            "lastname": "Carson",
            "fullname": "James Carson",
            "isOrganization": false,
            "email": "[email protected]",
            "dateactivated": "2003-01-01",
            "cleandateactivated": "Jan. 1, 2003",
            "status": "1",
            "statusname": "Active",
            "clienttypename": "Beta Tester",
            "clienttypebgcolor": "#000000"
        },
        {
            "clienttype": 0,
            "id": 109,
            "firstname": "Sammy",
            "lastname": "Davis",
            "fullname": "Sammy Davis",
            "isOrganization": false,
            "email": "[email protected]",
            "dateactivated": "2003-03-26",
            "cleandateactivated": "Mar. 26, 2003",
            "status": "1",
            "statusname": "Active",
            "clienttypename": "None",
            "clienttypebgcolor": ""
        },
        {
            "clienttype": 0,
            "id": 110,
            "firstname": "Joshua",
            "lastname": "Smith",
            "fullname": "Joshua Smith",
            "isOrganization": false,
            "email": "[email protected]",
            "dateactivated": "2003-03-27",
            "cleandateactivated": "Mar. 27, 2003",
            "status": "1",
            "statusname": "Active",
            "clienttypename": "None",
            "clienttypebgcolor": ""
        },
        {
            "clienttype": 0,
            "id": 111,
            "firstname": "Neil",
            "lastname": "Armstrong",
            "fullname": "Neil Armstrong",
            "isOrganization": false,
            "email": "[email protected]",
            "dateactivated": "2003-03-27",
            "cleandateactivated": "Mar. 27, 2003",
            "status": "1",
            "statusname": "Active",
            "clienttypename": "None",
            "clienttypebgcolor": ""
        },
        {
            "clienttype": 0,
            "id": 112,
            "firstname": "Damon",
            "lastname": "Ridges",
            "fullname": "Damon Ridges",
            "isOrganization": true,
            "email": "[email protected]",
            "dateactivated": "2003-03-28",
            "cleandateactivated": "Mar. 28, 2003",
            "status": "1",
            "statusname": "Active",
            "clienttypename": "None",
            "clienttypebgcolor": ""
        },
        {
            "clienttype": 0,
            "id": 115,
            "firstname": "Brandon",
            "lastname": "Miller",
            "fullname": "Brandon Miller",
            "isOrganization": false,
            "email": "[email protected]",
            "dateactivated": "2003-03-28",
            "cleandateactivated": "Mar. 28, 2003",
            "status": "1",
            "statusname": "Active",
            "clienttypename": "None",
            "clienttypebgcolor": ""
        },
        {
            "clienttype": 0,
            "id": 120,
            "firstname": "Angelica",
            "lastname": "Sigh",
            "fullname": "Angelica Sigh",
            "isOrganization": false,
            "email": "[email protected]",
            "dateactivated": "2003-03-31",
            "cleandateactivated": "Mar. 31, 2003",
            "status": "1",
            "statusname": "Active",
            "clienttypename": "None",
            "clienttypebgcolor": ""
        },
        {
            "clienttype": 0,
            "id": 122,
            "firstname": "Dan",
            "lastname": "Levens",
            "fullname": "Dan Levens",
            "isOrganization": true,
            "email": "[email protected]",
            "dateactivated": "2003-04-02",
            "cleandateactivated": "Apr. 2, 2003",
            "status": "1",
            "statusname": "Active",
            "clienttypename": "None",
            "clienttypebgcolor": ""
        },
        {
            "clienttype": 0,
            "id": 123,
            "firstname": "Karl",
            "lastname": "Stepp",
            "fullname": "Karl Stepp",
            "isOrganization": true,
            "email": "[email protected]",
            "dateactivated": "2003-04-03",
            "cleandateactivated": "Apr. 3, 2003",
            "status": "1",
            "statusname": "Active",
            "clienttypename": "None",
            "clienttypebgcolor": ""
        },
        {
            "clienttype": 0,
            "id": 126,
            "firstname": "Phil",
            "lastname": "Burrows",
            "fullname": "Phil Burrows",
            "isOrganization": false,
            "email": "[email protected]",
            "dateactivated": "2003-04-05",
            "cleandateactivated": "Apr. 5, 2003",
            "status": "1",
            "statusname": "Active",
            "clienttypename": "None",
            "clienttypebgcolor": ""
        }
    ],
    "elapsed": "0.609",
    "message": ""
}