API Documentation

Overview

Welcome to the tickzee API documentation. This API is designed to provide a seamless integration between systems. It empowers developers to build innovative applications using robust and flexible interfaces.

The use of tickzee API requires technical expertise and careful implementation. We strongly recommend reviewing the provided examples, guides, and FAQs to minimize the risk of errors.

Any misuse of this API is strictly prohibited. This includes, but is not limited to, using it for unethical, illegal, or malicious activities such as data manipulation, denial-of-service attacks, or breaches of privacy regulations. Violations may result in the suspension of access and could lead to legal consequences.

The tickzee API is provided “as is.” The provider assumes no liability for damages arising from improper use, misconfiguration, or external factors. It is the sole responsibility of the user to ensure correct implementation and compliance with applicable laws and regulations.

We look forward to supporting your projects and are available to assist with any questions or issues. For more details, please refer to the relevant sections of this documentation.

Endpoints


You can get the whole list of your tickzee Dot devices.

{
    "result": true,
    "devices": [
        {
            "id": 1111111111,
            "status": 1,
            "pin": "123456",
            "created": "0000-00-00 00:00:00"
        },
        {
            "id": 2222222222,
            "status": 0,
            "pin": "789101",
            "created": "0000-00-00 00:00:00"
        }
    ]
}

Only the linked user can unlink the tickzee Dot. For some calls, you will need the PIN, displayed on your tickzee Dot.

{
    "result": true,
    "device": "1111111111",
    "pin": "123456",
    "user": 0
}

Only the linked user can change data of the tickzee Dot.

{
    "result": true,
    "device": "1111111111",
    "pin": "123456",
    "user": 0
}

You can get the whole list of your clients. The team leader can assign the clients and edit them. These can be recognized by the owner parameter.

{
    "result": true,
    "pages": 1,
    "clients": [
        {
            "id": 0,
            "status": 1,
            "name": "Example Inc.",
            "nick": "Example",
            "owner": 1,
            "created": "0000-00-00 00:00:00",
            "updated": "0000-00-00 00:00:00",
            "users": [
                {
                    "user": 1,
                    "name": "Jan Smith",
                    "owner": 1,
                    "confirmed": 1
                },
                {
                    "user": 2,
                    "name": "John Doe",
                    "owner": 0,
                    "confirmed": 0
                }
            ]
        }
    ]
}

Add a new client to your time tracking system.

{
    "result": true,
    "id": "0",
    "name": "Example Inc.",
    "nick": "Example",
    "owner": 1,
    "created": "0000-00-00 00:00:00"
}

You can edit the data of a client, confirm a client to which you have been invited or add a user to a client of which you are the owner.

{
    "result": true,
    "id": "0",
    "name": "Example Inc.",
    "nick": "Example"
}

You can delete the entire client or disconnect certain users from the client. Deleting an entire client also deletes all projects and user links.

{
    "result": true,
    "id": "0",
    "name": "Example Inc.",
    "nick": "Example",
    "owner": 1,
    "created": "0000-00-00 00:00:00"
}

You can get the whole list of your projects. The team leader can assign the projects and edit them. These can be recognized by the owner parameter.

{
    "result": true,
    "pages": 1,
    "projects": [
        {
            "id": 0,
            "status": 1,
            "name": "Example Inc.",
            "nick": "Example",
            "owner": 1,
            "created": "0000-00-00 00:00:00",
            "updated": "0000-00-00 00:00:00",
            "users": [
                {
                    "user": 1,
                    "name": "Jan Smith",
                    "owner": 1,
                    "confirmed": 1
                },
                {
                    "user": 2,
                    "name": "John Doe",
                    "owner": 0,
                    "confirmed": 0
                }
            ]
        }
    ]
}

Add a new project to your time tracking system.

{
    "result": true,
    "id": "0",
    "name": "Example Inc.",
    "nick": "Example",
    "owner": 1,
    "created": "0000-00-00 00:00:00"
}

You can edit the data of a project, confirm a project to which you have been invited or add a user to a project of which you are the owner.

{
    "result": true,
    "id": "0",
    "name": "Example Inc.",
    "nick": "Example"
}

You can delete the entire project or disconnect certain users from the project. Deleting an entire project also deletes all projects and user links.

{
    "result": true,
    "id": "0",
    "name": "Example Inc.",
    "nick": "Example",
    "owner": 1,
    "created": "0000-00-00 00:00:00"
}

You can get the whole list of your time recordings. The team leader can see the time recordings. These can be recognized by the owner parameter.

{
    "result": true,
    "pages": 1,
    "times": [
        {
            "id": 0,
            "status": 1,
            "name": "Example Inc.",
            "nick": "Example",
            "owner": 1,
            "created": "0000-00-00 00:00:00",
            "updated": "0000-00-00 00:00:00",
            "users": [
                {
                    "user": 1,
                    "name": "Jan Smith",
                    "owner": 1,
                    "confirmed": 1
                },
                {
                    "user": 2,
                    "name": "John Doe",
                    "owner": 0,
                    "confirmed": 0
                }
            ]
        }
    ]
}

Add a new time to your time tracking system.

{
    "result": true,
    "user": "0",
    "id": "0",
    "start": "0000-00-00 00:00:00",
    "end": "0000-00-00 00:00:00",
    "created": "0000-00-00 00:00:00"
}

You can delete time recordings if you are the owner of a project.

{
    "result": true,
    "id": "0",
    "name": "Example Inc.",
    "nick": "Example",
    "owner": 1,
    "created": "0000-00-00 00:00:00"
}