General notes

Api is available at https://cloud.clientlist.io/partner-api/v1 under this conditions:

  • API always return JSON
  • content_type = application/json
  • authorization using HMAC
  • every right answer contains {“status”: “ok”}

Standard answers

Confirmation

{ “status”: “ok” } * always HTTP STATUS equals 200 * field status = “ok”

Error

{ “status”: “error”, “error”: “AccessDenied” } * error always has HTTP STATUS different than 200 (400,401,403,404,500) * it’s field status = “error” * error field can have additional parameter

Calculating a control sum of HMAC for GET and DELETE

X-hmac = hash_hmac(‘SHA1’ ,PUBLIC+REQUEST_PATH+HTTP_PARAMS, PRIVATE)

Calculating a control sum of HMAC for POST and PUT

X-hmac = hash_hmac(‘SHA1’, PUBLIC+REQUEST_PATH+HTTP_POST_JSON_BODY, PRIVATE)

API detail

Dictionary

Dictionary: Languages

HTTP Request
GET https://cloud.clientlist.io/partner-api/v1/language
Headers
X-public
833433b3adb6df69a79cb7af42f0b356
X-hmac
calculated_hmac
Example request
curl -X GET -H "X-public: 833433b3adb6df69a79cb7af42f0b356" -H "X-hmac: calculated_hmac" "https://cloud.clientlist.io/partner-api/v1/language"
GET /partner-api/v1/language HTTP/1.1
Host: cloud.clientlist.io
X-public: 833433b3adb6df69a79cb7af42f0b356
X-hmac: calculated_hmac
Example response
Status 200 OK
{
    "status": "ok",
    "data": [
        {
            "id": 1,
            "name": "English"
        },
        {
            "id": 2,
            "name": "Polski"
        },
        {
            "id": 3,
            "name": "German"
        },
        {
            "id": 4,
            "name": "French"
        },
        {
            "id": 5,
            "name": "Italian"
        },
        {
            "id": 6,
            "name": "Spanish"
        },
        {
            "id": 7,
            "name": "Arabic"
        },
        {
            "id": 8,
            "name": "Russian"
        }
    ]
}

Dictionary: List types

HTTP Request
GET https://cloud.clientlist.io/partner-api/v1/list-type
Headers
X-public
12313123qasdasd12313
X-hmac
calculated_hmac
Example request
curl -X GET -H "X-public: 12313123qasdasd12313" -H "X-hmac: calculated_hmac" "https://cloud.clientlist.io/partner-api/v1/list-type"
GET /partner-api/v1/list-type HTTP/1.1
Host: cloud.clientlist.io
X-public: 12313123qasdasd12313
X-hmac: calculated_hmac
Example response
Status 200 OK
{
    "status": "ok",
    "data": [
        {
            "id": 2,
            "name": "Agency"
        },
        {
            "id": 3,
            "name": "E-commerce"
        },
        {
            "id": 4,
            "name": "Services"
        },
        {
            "id": 5,
            "name": "Doctors"
        },
        {
            "id": 6,
            "name": "Lawyers"
        },
        {
            "id": 7,
            "name": "Internet Services"
        },
        {
            "id": 8,
            "name": "IoT"
        },
        {
            "id": 9,
            "name": "Beauty"
        },
        {
            "id": 10,
            "name": "Insurence"
        },
        {
            "id": 11,
            "name": "Photographers"
        },
        {
            "id": 12,
            "name": "SaaS"
        },
        {
            "id": 13,
            "name": "Education"
        },
        {
            "id": 14,
            "name": "Production"
        },
        {
            "id": 15,
            "name": "Consulting"
        },
        {
            "id": 17,
            "name": "Transportation"
        },
        {
            "id": 18,
            "name": "HR"
        },
        {
            "id": 19,
            "name": "Restaurants"
        },
        {
            "id": 20,
            "name": "Accounting"
        },
        {
            "id": 21,
            "name": "Freelancers"
        },
        {
            "id": 22,
            "name": "Real Estate"
        }
    ]
}

User

User: Get

HTTP Request
GET https://cloud.clientlist.io/partner-api/v1/user/:id
Headers
X-public
833433b3adb6df69a79cb7af42f0b356
X-hmac
callculated_hmac
Example request
curl -X GET -H "X-public: 833433b3adb6df69a79cb7af42f0b356" -H "X-hmac: callculated_hmac" "https://cloud.clientlist.io/partner-api/v1/user/:id"
GET /partner-api/v1/user/:id HTTP/1.1
Host: cloud.clientlist.io
X-public: 833433b3adb6df69a79cb7af42f0b356
X-hmac: callculated_hmac
Example response
Status 200 OK
{
    "status": "ok",
    "data": {
        "id": 2005,
        "name": "partner@example.com",
        "email": "partner@example.com",
        "language": 1,
        "timezone": "Europe/Warsaw",
        "status": true,
        "added": "2020-11-02 08:53:12",
        "lastLogin": "2020-11-02 08:53:12"
    }
}

User: Add

HTTP Request
POST https://cloud.clientlist.io/partner-api/v1/user
Headers
X-public
833433b3adb6df69a79cb7af42f0b356
X-hmac
callculated_hmac
Example request
curl -X POST -H "X-public: 833433b3adb6df69a79cb7af42f0b356" -H "X-hmac: callculated_hmac" -d '{
    "email": "partner@example.com",
    "password": "password1",
    "language": 1,
    "timezone": "Europe/Warsaw"
}' "https://cloud.clientlist.io/partner-api/v1/user"
POST /partner-api/v1/user HTTP/1.1
Host: cloud.clientlist.io
X-public: 833433b3adb6df69a79cb7af42f0b356
X-hmac: callculated_hmac

{
    "email": "partner@example.com",
    "password": "password1",
    "language": 1,
    "timezone": "Europe/Warsaw"
}
Example response
Status 200 OK
{
    "status": "ok",
    "data": {
        "id": 2005,
        "name": "partner@example.com",
        "email": "partner@example.com",
        "language": 1,
        "timezone": "Europe/Warsaw",
        "status": true,
        "added": "2020-11-02 08:53:12",
        "lastLogin": "2020-11-02 08:53:12"
    }
}

User: Status

HTTP Request
PUT https://cloud.clientlist.io/partner-api/v1/user/:id/status
Headers
X-public
833433b3adb6df69a79cb7af42f0b356
X-hmac
callculated_hmac
Example request
curl -X PUT -H "X-public: 833433b3adb6df69a79cb7af42f0b356" -H "X-hmac: callculated_hmac" -d '{
    "status": false
}' "https://cloud.clientlist.io/partner-api/v1/user/:id/status"
PUT /partner-api/v1/user/:id/status HTTP/1.1
Host: cloud.clientlist.io
X-public: 833433b3adb6df69a79cb7af42f0b356
X-hmac: callculated_hmac

{
    "status": false
}
Example response
Status 200 OK
{
    "status": "ok",
    "data": {
        "id": 2005,
        "name": "partner@example.com",
        "email": "partner@example.com",
        "language": 1,
        "timezone": "Europe/Warsaw",
        "status": false,
        "added": "2020-11-02 08:53:12",
        "lastLogin": "2020-11-02 08:53:12"
    }
}

User: Change password

HTTP Request
PUT https://cloud.clientlist.io/partner-api/v1/user/:id/password
Headers
X-public
833433b3adb6df69a79cb7af42f0b356
X-hmac
callucalted_hmac
Example request
curl -X PUT -H "X-public: 833433b3adb6df69a79cb7af42f0b356" -H "X-hmac: callucalted_hmac" -d '{
    "password": "password2"
}' "https://cloud.clientlist.io/partner-api/v1/user/:id/password"
PUT /partner-api/v1/user/:id/password HTTP/1.1
Host: cloud.clientlist.io
X-public: 833433b3adb6df69a79cb7af42f0b356
X-hmac: callucalted_hmac

{
    "password": "password2"
}
Example response
Status 200 OK
{
    "status": "ok",
    "data": {
        "id": 2005,
        "name": "partner@example.com",
        "email": "partner@example.com",
        "language": 1,
        "timezone": "Europe/Warsaw",
        "status": false,
        "added": "2020-11-02 08:53:12",
        "lastLogin": "2020-11-02 08:53:12"
    }
}

User: Remove

HTTP Request
DELETE https://cloud.clientlist.io/partner-api/v1/user/:id
Headers
X-public
833433b3adb6df69a79cb7af42f0b356
X-hmac
callculated_hmac
Example request
curl -X DELETE -H "X-public: 833433b3adb6df69a79cb7af42f0b356" -H "X-hmac: callculated_hmac" "https://cloud.clientlist.io/partner-api/v1/user/:id"
DELETE /partner-api/v1/user/:id HTTP/1.1
Host: cloud.clientlist.io
X-public: 833433b3adb6df69a79cb7af42f0b356
X-hmac: callculated_hmac
Example response
Status 200 OK
{
    "status": "ok"
}

User: Sign in

HTTP Request
POST https://cloud.clientlist.io/partner-api/v1/user/login-email
Headers
X-public
833433b3adb6df69a79cb7af42f0b356
X-hmac
callculated_hmac
Example request
curl -X POST -H "X-public: 833433b3adb6df69a79cb7af42f0b356" -H "X-hmac: callculated_hmac" -d '{
    "email": "partner@example.com",
    "list_id": 1 //optional
}' "https://cloud.clientlist.io/partner-api/v1/user/login-email"
POST /partner-api/v1/user/login-email HTTP/1.1
Host: cloud.clientlist.io
X-public: 833433b3adb6df69a79cb7af42f0b356
X-hmac: callculated_hmac

{
    "email": "partner@example.com",
    "list_id": 1 //optional
}
Example response
Status 200 OK
{
    "status": "ok",
    "data": {
        "hash": "13aa2c620760e92e279053530d294b47",
        "url": "https://cloud.clientlist.io/login-otp/13aa2c620760e92e279053530d294b47"
    }
}

User: Back btn

HTTP Request
PUT https://cloud.clientlist.io/partner-api/v1/user/:id/back-btn
Headers
X-public
833433b3adb6df69a79cb7af42f0b356
X-hmac
clculated_hmac
Example request
curl -X PUT -H "X-public: 833433b3adb6df69a79cb7af42f0b356" -H "X-hmac: clculated_hmac" -d '{
    "backBtnTop": true,
    "backBtnFooter": true,
    "backBtn": "https://example.com",
    "backBtnTxt": "Optional text"
}' "https://cloud.clientlist.io/partner-api/v1/user/:id/back-btn"
PUT /partner-api/v1/user/:id/back-btn HTTP/1.1
Host: cloud.clientlist.io
X-public: 833433b3adb6df69a79cb7af42f0b356
X-hmac: clculated_hmac

{
    "backBtnTop": true,
    "backBtnFooter": true,
    "backBtn": "https://example.com",
    "backBtnTxt": "Optional text"
}
Example response
Status 200 OK
{
    "status": "ok",
    "data": {
        "id": 1,
        "name": "Administrator",
        "email": "admin@example.com",
        "language": 2,
        "timezone": "Europe/Warsaw",
        "status": true,
        "added": "2016-03-08 09:35:03",
        "lastLogin": "2023-03-03 09:51:30"
    }
}

User: Logo upload

Upload file as post field “logo” value

HTTP Request
POST https://cloud.ocl.to/partner-api/v1/user/upload-logo
Headers
X-public
833433b3adb6df69a79cb7af42f0b356
X-hmac
calculated_hmac
Example request
curl -X POST -H "X-public: 833433b3adb6df69a79cb7af42f0b356" -H "X-hmac: calculated_hmac" "https://cloud.ocl.to/partner-api/v1/user/upload-logo"
POST /partner-api/v1/user/upload-logo HTTP/1.1
Host: cloud.ocl.to
X-public: 833433b3adb6df69a79cb7af42f0b356
X-hmac: calculated_hmac
Example response
Status 200 OK
{
    "status": "ok",
    "data": {
        "file": "/img/logo/648fcc497ace8770fa9e7c6dd90205bc.png"
    }
}
HTTP Request
PUT https://cloud.ocl.to/partner-api/v1/user/:user_id/logo
Headers
X-public
833433b3adb6df69a79cb7af42f0b356
X-hmac
calculated_hmac
Example request
curl -X PUT -H "X-public: 833433b3adb6df69a79cb7af42f0b356" -H "X-hmac: calculated_hmac" -d '{
    "logoWhite": "",
    "logoBlack": ""
}' "https://cloud.ocl.to/partner-api/v1/user/:user_id/logo"
PUT /partner-api/v1/user/:user_id/logo HTTP/1.1
Host: cloud.ocl.to
X-public: 833433b3adb6df69a79cb7af42f0b356
X-hmac: calculated_hmac

{
    "logoWhite": "",
    "logoBlack": ""
}
Example response
Status 200 OK
{
    "status": "ok",
    "data": {
        "id": 1,
        "name": "Administrator",
        "email": "admin@example.com",
        "language": 2,
        "timezone": "Europe/Warsaw",
        "status": true,
        "added": "2016-03-08 09:35:03",
        "lastLogin": "2023-03-08 08:23:22",
        "backBtnTop": false,
        "backBtnFooter": false,
        "backBtn": null,
        "backBtnTxt": "Optional text",
        "logoWhite": "/img/logo/655601e913125120e65aca1b908bac34.png",
        "logoBlack": "/img/logo/1b50b61612aa198e423ae596c503510c.png"
    }
}

User: Limits

HTTP Request
PUT https://cloud.ocl.to/partner-api/v1/user/:user_id/limit
Headers
X-public
833433b3adb6df69a79cb7af42f0b356
X-hmac
calculated_hmac
Example request
curl -X PUT -H "X-public: 833433b3adb6df69a79cb7af42f0b356" -H "X-hmac: calculated_hmac" -d '{
    "clientLimit": 10000,
    "userLimit": 10,
    "storageLimit": 5242880
}' "https://cloud.ocl.to/partner-api/v1/user/:user_id/limit"
PUT /partner-api/v1/user/:user_id/limit HTTP/1.1
Host: cloud.ocl.to
X-public: 833433b3adb6df69a79cb7af42f0b356
X-hmac: calculated_hmac

{
    "clientLimit": 10000,
    "userLimit": 10,
    "storageLimit": 5242880
}
Example response
Status 200 OK
{
    "status": "ok",
    "data": {
        "id": 1,
        "name": "Administrator",
        "email": "admin@example.com",
        "language": 2,
        "timezone": "Europe/Warsaw",
        "status": true,
        "added": "2016-03-08 09:35:03",
        "lastLogin": "2023-03-08 11:50:29",
        "backBtnTop": false,
        "backBtnFooter": false,
        "backBtn": null,
        "backBtnTxt": "Optional text",
        "logoWhite": "/img/logo/e0ec0c4963a9c6f99d6a8c9c9c381fce.png",
        "logoBlack": "/img/logo/693c9e4a9dfce3ca8c0690681f9ce9cc.png",
        "userLimit": 10,
        "clientLimit": 10000,
        "storageLimit": 5242880
    }
}

User: Billing tab

1 - Inherit from global value
2 - On
3 - Off

HTTP Request
PUT https://cloud.ocl.to/partner-api/v1/user/:user_id/billing-tab
Headers
X-public
833433b3adb6df69a79cb7af42f0b356
X-hmac
calculated_hmac
Example request
curl -X PUT -H "X-public: 833433b3adb6df69a79cb7af42f0b356" -H "X-hmac: calculated_hmac" -d '{
    "showBilling": 2
}' "https://cloud.ocl.to/partner-api/v1/user/:user_id/billing-tab"
PUT /partner-api/v1/user/:user_id/billing-tab HTTP/1.1
Host: cloud.ocl.to
X-public: 833433b3adb6df69a79cb7af42f0b356
X-hmac: calculated_hmac

{
    "showBilling": 2
}
Example response
Status 200 OK
{
    "status": "ok",
    "data": {
        "id": 1,
        "name": "Administrator",
        "email": "admin@example.com",
        "language": 2,
        "timezone": "Europe/Warsaw",
        "status": true,
        "added": "2016-03-08 09:35:03",
        "lastLogin": "2023-05-15 07:22:38",
        "backBtnTop": false,
        "backBtnFooter": false,
        "backBtn": null,
        "backBtnTxt": "Optional text",
        "logoWhite": "/img/logo/31a3871985252bd3e056495b6bf4e2fa.png",
        "logoBlack": "/img/logo/c202a7dc79301f2d4b7d1021e4fddc26.png",
        "userLimit": "5",
        "clientLimit": -1,
        "storageLimit": "524288000",
        "showBilling": 2
    }
}

User: Allow add list

HTTP Request
PUT https://cloud.ocl.to/partner-api/v1/user/:user_id/allow-add-list
Headers
X-public
833433b3adb6df69a79cb7af42f0b356
X-hmac
calculated_hmac
Example request
curl -X PUT -H "X-public: 833433b3adb6df69a79cb7af42f0b356" -H "X-hmac: calculated_hmac" -d '{
    "allowAddList": false
}' "https://cloud.ocl.to/partner-api/v1/user/:user_id/allow-add-list"
PUT /partner-api/v1/user/:user_id/allow-add-list HTTP/1.1
Host: cloud.ocl.to
X-public: 833433b3adb6df69a79cb7af42f0b356
X-hmac: calculated_hmac

{
    "allowAddList": false
}
Example response
Status 200 OK
{
    "status": "ok",
    "data": {
        "id": 1,
        "name": "Administrator",
        "email": "admin@example.com",
        "language": 2,
        "timezone": "Europe/Warsaw",
        "status": true,
        "added": "2016-03-08 09:35:03",
        "lastLogin": "2023-06-02 08:27:41",
        "backBtnTop": false,
        "backBtnFooter": false,
        "backBtn": null,
        "backBtnTxt": "Optional text",
        "logoWhite": "/img/logo/31a3871985252bd3e056495b6bf4e2fa.png",
        "logoBlack": "/img/logo/c202a7dc79301f2d4b7d1021e4fddc26.png",
        "userLimit": "120",
        "clientLimit": 2000000,
        "storageLimit": "5242880",
        "showBilling": 2,
        "allowAddList": false
    }
}

User: Settings

accountType: 1 - normal, 2 - premium, 3 - special
storageLimit in bytes
all limits: -1 its unlimited

HTTP Request
PUT https://cloud.ocl.to/partner-api/v1/user/:user_id/settings
Headers
X-public
833433b3adb6df69a79cb7af42f0b356
X-hmac
calculated_hmac
Example request
curl -X PUT -H "X-public: 833433b3adb6df69a79cb7af42f0b356" -H "X-hmac: calculated_hmac" -d '{
    "accountType": 2,
    "clientLimit": -1,
    "storageLimit": -1,
    "userLimit": -1
}' "https://cloud.ocl.to/partner-api/v1/user/:user_id/settings"
PUT /partner-api/v1/user/:user_id/settings HTTP/1.1
Host: cloud.ocl.to
X-public: 833433b3adb6df69a79cb7af42f0b356
X-hmac: calculated_hmac

{
    "accountType": 2,
    "clientLimit": -1,
    "storageLimit": -1,
    "userLimit": -1
}
Example response
Status 200 OK
{
    "status": "ok",
    "data": {
        "id": 1,
        "name": "Administrator",
        "email": "admin@example.com",
        "language": 1,
        "timezone": "Europe/Warsaw",
        "status": true,
        "added": "2016-03-08 09:35:03",
        "lastLogin": "2023-09-01 10:32:23",
        "backBtnTop": false,
        "backBtnFooter": false,
        "backBtn": null,
        "backBtnTxt": "Optional text",
        "logoWhite": "/img/logo/31a3871985252bd3e056495b6bf4e2fa.png",
        "logoBlack": "/img/logo/c202a7dc79301f2d4b7d1021e4fddc26.png",
        "userLimit": -1,
        "clientLimit": -1,
        "storageLimit": -1,
        "showBilling": 2,
        "allowAddList": true
    }
}

User: Show integrations

HTTP Request
PUT https://cloud.ocl.to/partner-api/v1/user/:user_id/show-integrations
Headers
X-public
833433b3adb6df69a79cb7af42f0b356
X-hmac
calculated_hmac
Example request
curl -X PUT -H "X-public: 833433b3adb6df69a79cb7af42f0b356" -H "X-hmac: calculated_hmac" -d '{
    "showIntegrations": false
}' "https://cloud.ocl.to/partner-api/v1/user/:user_id/show-integrations"
PUT /partner-api/v1/user/:user_id/show-integrations HTTP/1.1
Host: cloud.ocl.to
X-public: 833433b3adb6df69a79cb7af42f0b356
X-hmac: calculated_hmac

{
    "showIntegrations": false
}
Example response
Status 200 OK
{
    "status": "ok",
    "data": {
        "id": 1,
        "name": "Administrator",
        "email": "admin@example.com",
        "language": 1,
        "timezone": "Europe/Warsaw",
        "status": true,
        "added": "2016-03-08 09:35:03",
        "lastLogin": "2023-09-06 07:08:04",
        "backBtnTop": false,
        "backBtnFooter": false,
        "backBtn": null,
        "backBtnTxt": "Optional text",
        "logoWhite": "/img/logo/31a3871985252bd3e056495b6bf4e2fa.png",
        "logoBlack": "/img/logo/c202a7dc79301f2d4b7d1021e4fddc26.png",
        "userLimit": "-1",
        "clientLimit": -1,
        "storageLimit": "-1",
        "showBilling": 2,
        "allowAddList": true,
        "showIntegrations": false
    }
}

User: Hide modules

HTTP Request
PUT https://cloud.ocl.to/partner-api/v1/user/:user_id/hidden-modules
Headers
X-public
833433b3adb6df69a79cb7af42f0b356
X-hmac
calculated_hmac
Example request
curl -X PUT -H "X-public: 833433b3adb6df69a79cb7af42f0b356" -H "X-hmac: calculated_hmac" -d '{
    "button": false,
    "invoice": false
}' "https://cloud.ocl.to/partner-api/v1/user/:user_id/hidden-modules"
PUT /partner-api/v1/user/:user_id/hidden-modules HTTP/1.1
Host: cloud.ocl.to
X-public: 833433b3adb6df69a79cb7af42f0b356
X-hmac: calculated_hmac

{
    "button": false,
    "invoice": false
}
Example response
Status 200 OK
{
    "status": "ok",
    "data": {
        "assets": 1,
        "calendar": 1,
        "files": 1,
        "information": 1,
        "sms": 1,
        "mail": 1,
        "evidence": 1,
        "clientPanel": 1,
        "support": 1,
        "sale": 1,
        "invoice": 0,
        "diagnostic": 1,
        "todo": 1,
        "gantt": 1,
        "metric": 1,
        "map": 1,
        "infoline": 0,
        "docs": 1,
        "contacts": 1,
        "trc": 1,
        "twilio": 1,
        "bank": 1,
        "invoiceCost": 1,
        "bill": 1,
        "contractor": 1,
        "employee": 1,
        "status": 1,
        "id": 1,
        "button": 0
    }
}

List

List: Add

shortType:
1 - Accounts
2 - Appointments
3 - Sales
4 - Expirations
5 - Entry

HTTP Request
POST https://cloud.clientlist.io/partner-api/v1/user/:id/list/add
Headers
X-hmac
calculated_hmac
X-public
833433b3adb6df69a79cb7af42f0b356
Content-type
application/json
Example request
curl -X POST -H "X-hmac: calculated_hmac" -H "X-public: 833433b3adb6df69a79cb7af42f0b356" -H "Content-type: application/json" -d '{
    "name": "My list",
    "type": 3, //optional
    "shortType": 4 //optional
}' "https://cloud.clientlist.io/partner-api/v1/user/:id/list/add"
POST /partner-api/v1/user/:id/list/add HTTP/1.1
Host: cloud.clientlist.io
X-hmac: calculated_hmac
X-public: 833433b3adb6df69a79cb7af42f0b356
Content-type: application/json

{
    "name": "My list",
    "type": 3, //optional
    "shortType": 4 //optional
}
Example response
Status 200 OK
{
    "status": "ok",
    "data": {
        "id": 2085,
        "name": "My list",
        "apiKey": "2af471cf8f4986441cdb4167b2d4d3ea"
    }
}

List: Add user

HTTP Request
POST https://cloud.clientlist.io/partner-api/v1/list/:id/user
Headers
X-hmac
calculated_hmac
X-public
833433b3adb6df69a79cb7af42f0b356
Content-type
application/json
Example request
curl -X POST -H "X-hmac: calculated_hmac" -H "X-public: 833433b3adb6df69a79cb7af42f0b356" -H "Content-type: application/json" -d '{
    "email": "partner@example.com",
    "password": "password1",
    "language": 1,
    "timezone": "Europe/Warsaw"
}' "https://cloud.clientlist.io/partner-api/v1/list/:id/user"
POST /partner-api/v1/list/:id/user HTTP/1.1
Host: cloud.clientlist.io
X-hmac: calculated_hmac
X-public: 833433b3adb6df69a79cb7af42f0b356
Content-type: application/json

{
    "email": "partner@example.com",
    "password": "password1",
    "language": 1,
    "timezone": "Europe/Warsaw"
}
Example response
Status 200 OK
{
    "status": "ok",
    "data": {
        "id": 1622,
        "name": "partner123@example.com",
        "email": "partner123@example.com",
        "language": 1,
        "timezone": "Europe/Warsaw",
        "status": true,
        "added": "2021-05-21 12:55:35",
        "lastLogin": "2021-05-21 12:55:35"
    }
}

List: Add client

HTTP Request
POST https://dev.damnlist.com/partner-api/v1/user/1/list/1857/client-add
Headers
X-hmac
skip_32141
X-public
f69628f254ac4df93dc389884dfb747b
Content-type
application/json
Example request
curl -X POST -H "X-hmac: skip_32141" -H "X-public: f69628f254ac4df93dc389884dfb747b" -H "Content-type: application/json" -d '{
    "name": "My new client"
}' "https://dev.damnlist.com/partner-api/v1/user/1/list/1857/client-add"
POST /partner-api/v1/user/1/list/1857/client-add HTTP/1.1
Host: dev.damnlist.com
X-hmac: skip_32141
X-public: f69628f254ac4df93dc389884dfb747b
Content-type: application/json

{
    "name": "My new client"
}
Example response
Status 200 OK
{
    "status": "ok",
    "data": {
        "id": 79187,
        "name": "My new client"
    }
}

List: Invite member

HTTP Request
POST https://cloud.clientlist.io/partner-api/v1/list/:lid/member/add
Headers
X-hmac
skip_32141
X-public
f69628f254ac4df93dc389884dfb747b
Content-type
application/json
Example request
curl -X POST -H "X-hmac: skip_32141" -H "X-public: f69628f254ac4df93dc389884dfb747b" -H "Content-type: application/json" -d '{
    "username": "Username",
    "email": "example1234@example.com"
}' "https://cloud.clientlist.io/partner-api/v1/list/:lid/member/add"
POST /partner-api/v1/list/:lid/member/add HTTP/1.1
Host: cloud.clientlist.io
X-hmac: skip_32141
X-public: f69628f254ac4df93dc389884dfb747b
Content-type: application/json

{
    "username": "Username",
    "email": "example1234@example.com"
}
Example response
Status 200 OK
{
    "status": "ok",
    "data": {
        "id": 13184,
        "username": "Username",
        "email": "example@example.com"
    }
}

List: Remove member

HTTP Request
DELETE https://cloud.clientlist.io/partner-api/v1/list/:lid/member/:mid/remove
Headers
X-hmac
calculated_hmac
X-public
f69628f254ac4df93dc389884dfb747b
Content-type
application/json
Example request
curl -X DELETE -H "X-hmac: calculated_hmac" -H "X-public: f69628f254ac4df93dc389884dfb747b" -H "Content-type: application/json" "https://cloud.clientlist.io/partner-api/v1/list/:lid/member/:mid/remove"
DELETE /partner-api/v1/list/:lid/member/:mid/remove HTTP/1.1
Host: cloud.clientlist.io
X-hmac: calculated_hmac
X-public: f69628f254ac4df93dc389884dfb747b
Content-type: application/json
Example response
Status 200 OK
{
    "status": "ok"
}

List: Get

HTTP Request
GET https://cloud.clientlist.io/partner-api/v1/list/:id/show
Headers
X-hmac
calculated_hmac
X-public
f69628f254ac4df93dc389884dfb747b
Content-type
application/json
Example request
curl -X GET -H "X-hmac: calculated_hmac" -H "X-public: f69628f254ac4df93dc389884dfb747b" -H "Content-type: application/json" "https://cloud.clientlist.io/partner-api/v1/list/:id/show"
GET /partner-api/v1/list/:id/show HTTP/1.1
Host: cloud.clientlist.io
X-hmac: calculated_hmac
X-public: f69628f254ac4df93dc389884dfb747b
Content-type: application/json
Example response
Status 200 OK
{
    "status": "ok",
    "data": {
        "id": 1,
        "name": "Administrator",
        "email": "admin@example.com",
        "language": 2,
        "timezone": "Europe/Warsaw",
        "status": true,
        "added": "2016-03-08 09:35:03",
        "lastLogin": "2023-08-07 12:45:10",
        "backBtnTop": false,
        "backBtnFooter": false,
        "backBtn": null,
        "backBtnTxt": "Optional text",
        "logoWhite": "/img/logo/31a3871985252bd3e056495b6bf4e2fa.png",
        "logoBlack": "/img/logo/c202a7dc79301f2d4b7d1021e4fddc26.png",
        "userLimit": "50",
        "clientLimit": 200000,
        "storageLimit": "5242880000",
        "showBilling": 2,
        "allowAddList": true
    }
}