Einpix API documentation
    Einpix API documentation
    • Changelog
    • About
    • API
      • Task
        • Create
        • List
        • Detail
        • Change status
      • Checklist
        • By task
      • Client
        • List
        • Detail
      • User
        • List
        • Detail
      • Venue
        • Create
        • List
        • Detail
      • Category
        • Task
          • List
          • Detail
      • Tag
        • List
        • Detail
      • Template
        • Checklist
          • List
          • Detail
      • Equipment
        • List
        • Detail
      • Comment
        • Create
        • Detail
      • Worklog
        • List
        • Hisory
      • Materials
        • By task
      • Service
        • By task
    • Schemas
      • User
      • Venue
      • Task
      • Task comment
      • Tag
      • Task category
      • Picture
      • Check item
      • Equipment
      • Client
      • Task severity
      • Attachment
      • Changed log
      • User group
      • WDJ material
      • Unit master
      • WDJ service
      • Worklog History
      • Checklist template
      • Worklog
      • Activity task
      • Downtime task
      • Sla rule

    About

    Einpix API#

    Overview#

    Einpix API allows users to manage and interact with tasks, users, and other resources within the einpix platform.
    The API follows RESTful principles and requires authentication using an API Key.

    Authentication#

    All requests to the einpix API must include an API key in the request headers. The API key must be sent as x-api-key.

    Example:#

    If the API key is missing or invalid, the request will be rejected with a 401 Unauthorized response.

    Base URL#

    The base URL for all API requests:
    https://api.einpix.com/

    Endpoints#

    Get Tasks#

    Retrieve a paginated list of tasks.
    Request:
    Response:
    [
        {
            "id": 2602418338063740,
            "title": "Regional Accounts Director",
            "status": "new",
            "description": "Future",
            "location": "Location #1",
            "reporter": {
                "id": 8352614865856043,
                "name": "Mona Franecki",
                "email": "Julia_Batz@yahoo.com"
            },
            "assignees": [
                {
                    "id": 8579185966500378,
                    "name": "Charlotte Purdy",
                    "email": "Daisha18@hotmail.com"
                },
                {
                    "id": 4948202057363023,
                    "name": "Deborah Kirlin",
                    "email": "Alyson_Dach20@gmail.com"
                }
            ],
            "responsible": {
                "id": 3437658260780838,
                "name": "Adrienne Swift",
                "email": "Carmen.Ward84@hotmail.com"
            },
            "venue": {
                "id": 8208950502475630,
                "name": "574 Roderick MountMax Funk"
            },
            "comments": [
                {
                    "id": 1,
                    "author": {
                        "id": 6637011828144249,
                        "name": "Lisa Mante",
                        "email": "Franz_Jakubowski@gmail.com"
                    },
                    "content": "New ABC 13 9370, 13.3, 5th Gen CoreA5-8250U, 8GB RAM, 256GB SSD, power UHD Graphics, OS 10 Home, OS Office A & J 2016Need to discuss"
                },
                {
                    "id": 1,
                    "author": {
                        "id": 5840448913165518,
                        "name": "Preston Lowe",
                        "email": "Tyrell.Mante23@gmail.com"
                    },
                    "content": "New ABC 13 9370, 13.3, 5th Gen CoreA5-8250U, 8GB RAM, 256GB SSD, power UHD Graphics, OS 10 Home, OS Office A & J 2016Need to discuss"
                }
            ],
            "comment_count": 24,
            "tags": [
                {
                    "id": "ddd4e3f5-79a1-479b-a7a5-43a836d74f0a",
                    "name": "0o5",
                    "active": true
                }
            ],
            "category": {
                "id": "b9d8c19e-b670-43a6-abc2-0bdfe043114e",
                "name": "Intelligent"
            },
            "severity": {
                "code": "low",
                "label": "Low"
            },
            "picture": null,
            "checklist": [
                {
                    "id": "3a2b9d4e-40e1-4d57-af2c-f5c5302c5f4e",
                    "label": "Checklist label #1",
                    "type": "checkbox"
                },
                {
                    "id": "9405726e-975b-4f4a-91cc-2ea391d0ec1b",
                    "label": "Checklist label #1",
                    "type": "equipment"
                }
            ],
            "equipment": null,
            "client": {
                "id": "7103360f-81e2-4b55-8b5c-5308eeb5c12b",
                "name": "Andrea Legros-Mann"
            },
            "scheduled_start_date": "2025-02-14T23:31:02+02:00",
            "scheduled_start_time": "00:03",
            "scheduled_end_date": "2024-03-07T02:00:04+02:00",
            "scheduled_end_time": "00:16",
            "resolution_deadline": "2024-07-14T06:49:46+03:00",
            "reaction_deadline": "2025-01-20T03:45:09+02:00",
            "watchers": [
                {
                    "id": 90812521687461,
                    "name": "Mr. Drew Williamson",
                    "email": "Buck27@hotmail.com"
                }
            ],
            "requires_approval": true,
            "is_approved": false,
            "approved_date": "2024-11-15T02:41:28+02:00",
            "is_visible_to_partners": true,
            "duration": null,
            "is_auto_assigned": true,
            "created": "2024-12-12T09:30:47+02:00",
            "updated": "2024-08-03T13:56:34+03:00",
            "changed_logs": [
                {
                    "id": "600e6ca2-1bf7-4bcb-96d6-e338d131300c",
                    "column": "status",
                    "log": {
                        "en": "Task status changed from New to Missed",
                        "pl": "Status zadania zmieniono z Nowy na Nieodebrane",
                        "lt": "Užduoties būsena pakeista iš Nauja į Praleista",
                        "ru": "Статус задачи изменен с Новая на Пропущено"
                    }
                },
                {
                    "id": "9d6a6558-7be1-4bca-9d63-5f9e3e06394f",
                    "column": "status",
                    "log": {
                        "en": "Task status changed from New to Missed",
                        "pl": "Status zadania zmieniono z Nowy na Nieodebrane",
                        "lt": "Užduoties būsena pakeista iš Nauja į Praleista",
                        "ru": "Статус задачи изменен с Новая на Пропущено"
                    }
                },
                {
                    "id": "8d39794d-bd00-4f1b-bddf-7abf2b42dd7e",
                    "column": "status",
                    "log": {
                        "en": "Task status changed from New to Missed",
                        "pl": "Status zadania zmieniono z Nowy na Nieodebrane",
                        "lt": "Užduoties būsena pakeista iš Nauja į Praleista",
                        "ru": "Статус задачи изменен с Новая на Пропущено"
                    }
                }
            ]
        }
    ]

    Error Handling#

    Status CodeMeaning
    200Success
    400Bad Request
    401Unauthorized (Invalid API Key)
    404Resource Not Found
    500Internal Server Error

    License#

    Einpix API is proprietary software. Unauthorized use, distribution, or modification is strictly prohibited.

    Contact#

    For support, contact support@einpix.com.
    Modified at 2025-02-19 10:14:59
    Previous
    Changelog
    Next
    Create
    Built with