eLogii
    • Introduction
    • Entities
    • FAQs
    • Query parameters
    • Webhooks
    • Tasks
      • Task Elements
      • createOrUpdateMany
        POST
      • Get tasks
        GET
      • Create tasks
        POST
      • Delete tasks
        POST
      • Update a task
        PUT
      • Get Proof of Delivery
        GET
      • Cancel tasks
        POST
      • Post Tasks Create Return
        POST
      • Move tasks to another date
        POST
      • postTasksReattempt
        POST
      • Start tracking a task (webhook)
        POST
    • Drivers
      • Driver Elements
      • Get drivers
        GET
      • Create multiple drivers
        POST
      • Update drivers
        POST
      • Delete drivers
        POST
    • Customers
      • Customer Elements
      • Get customers
        GET
      • Create customers
        POST
      • Update customers
        POST
      • Delete customers
        POST
    • Depots
      • Depot Elements
      • Get depots
      • Create depots
      • Update depots
      • Delete depots
    • Driver-schedule-exceptions
      • Driver-schedule-exception elements
      • Get all exceptions
      • Get schedule exception for a specific driver
      • Update a schedule exception
      • Create multiple schedule exceptions
      • Delete multiple schedule exceptions
    • Route-template-groups
      • Route-template-groups elements
      • Get route template groups
      • Create a route-template-group
      • Update a route template group
      • Delete multiple route template groups
      • Schedule for dates
    • Routes
      • Route Elements
      • Get routes
      • Clear route(s)
      • Lock route(s)
      • Unlock route(s)
      • Set planned ETAs
      • Setting the task order
    • Task-template-groups
      • Task-template-groups Elements
      • Get task-template-groups
      • Create task-template-groups
      • Get one task-template-group by _id
      • Update task-template-group
      • Delete one task-template-group
      • Delete multiple task-template-groups
      • Schedule task-template-groups for dates
      • Add tasks to group
    • Vehicles
      • Vehicle Elements
      • Create multiple vehicles
      • Get vehicles
      • Update multiple vehicles
      • Delete multiple vehicles
    • Zones
      • Zones Elements
      • getZones
      • postZones
      • putZones_id
      • deleteZones_id
    • Optimization
      • Optimization Elements
      • Run optimization for provided data set
      • Run optimization for one or multiple dates
      • Run optimization for one or multiple existing routes
      • Optimize tasks in a period (e.g. 1 month), where some of the tasks have varying intervals - e.g. weekly, every 2 weeks, monthly
      • Run optimization for a date range
    • Forms
      • Get all forms
      • Create and design a form
      • Update many forms
      • Delete many forms
    • Form submissions
      • Get all form submissions
      • Get a specific form's submissions
      • Update many form submissions
      • Delete many form submissions

    Query parameters

    📌
    Query parameters are key-value pairs added to an API request to filter, sort, or otherwise control the data returned. They are appended to the endpoint after a '?' and are separated by '&' when using multiple parameters.
    Parameter key-value pairs supported by eLogii's API include:

    Sort#

    The sort parameter arranges response data in a specific order.
    Example:
    GET https://api-35.elogii.com/tasks?sort=_id&date=20250812
    This retrieves tasks for 12-08-2025 sorted by the task _id.

    Limit#

    This restricts the size of the response payload.It's useful for large datasets.
    Example
    GET https://api-35.elogii.com/drivers?limit=2
    It returns only two driver profiles instead of the full dataset(all driver profiles).

    Filter#

    eLogii’s API supports MongoDB-style:- $regrex(regular expressions for pattern matching) and $type(for data type checks).
    End of Value
    Type (Format)
    Start of Value
    Value Contained Anywhere
    Example:
    GET /tasks?date=20250813&filter={"customData.Priority":{"$regex":"11$"}}
    This returns tasks for 13-08-2025 where the custom data-Piriority ends with 11.

    Select#

    This key specifies which fields to return in the response.
    Example:
    GET /drivers?select=lastName
    This returns only the driver's lastName and mandatory _id field.

    Using Entity Data as Query Parameters#

    Entity data (UID, driver name, route ID, task reference, customer name, task dates, etc.) can be used as query parameters.
    Example:
    GET /routes?date=20250813
    This returns route data for 13-08-2025.
    Modified at 2025-11-12 16:33:16
    Previous
    FAQs
    Next
    Webhooks
    Built with