📌 Overview

This document provides detailed specifications for two related endpoints:

POST https://app.getstatus.online/api/exposed/routes — Retrieves route data based on filters ♦
POST https://app.getstatus.online/api/exposed/routes/stats — Returns signature status of routes ♦
POST https://app.getstatus.online/api/exposed/users — Returns Invites of a route ♦

Both endpoints support API Key authentication.



Shared Request Body Fields for /routes and /routes/stats



Field

Type

Description

status

Array (optional)

Filters by route status:
• 1 = In Progress
• 2 = Suspended/Canceled
• 3 = Completed

drivers

ObjectId (optional)

Filters by specific driver

orgId

Array of ObjectIds (optional)

Filters by organization IDs



🧭 Fetch Routes With Metadata
POST https://app.getstatus.online/api/exposed/routes

Authentication

Supports the following:

API Key Headers:

x-api-key: <your-api-key>
x-api-secret: <your-api-secret>
 



Query Parameters

Param

Type

Description

skip

Number (optional)

Records to skip

limit

Number (required)

Max records to return⚠️ limit - skip must not exceed 200



Request Body (JSON)

{

  "status": [1, 2, 3],

  "drivers": "<ObjectId>",

  "orgId": ["<ObjectId>"],

  "accounts": ["<ObjectId>"],

  "search": "<search string>"

}

 

Additional Filters

Array of stakeholder account IDs (direct or pending)
 account ♦
Search by route name, passenger email, or phone number search ♦



Example Request

curl --location --request POST 'https://app.getstatus.online/api/exposed/routes?skip=10&limit=20' \

--header 'x-api-key: KEY \

--header 'x-api-secret: SECRET'' \

--header 'Content-Type: application/json' \

--data-raw '{

  "status": [1,2, 3],

  "accounts": ["64ab0c1234567890abcdef12"],

  "search": "route name"

}'



Example Response

{

  "routeData": {

    "routes": [

      {

        "_id": "673efd3b60a7bffdb32a4d00",

        "name": "Test Route 1r",

          "metadata": [

          {

            "_id": "673efd3b60a7bffdb32a4d01",

            "name": "List",

            "show": false,

            "isVisible": false,

            "userEdit": false,

            "labels": [],

            "type": "list",

            "values": ["One", "Two", "Three"],

            "value": "Two",

            "order": 0,

            "lastChange": "2025-10-08T10:53:02.798Z"

          }

        ]

      }

    ],

    "totalRoutes": 4025

  }

}





📊 Fetch Signature Status of Routes
 POST https://app.getstatus.online/api/exposed/routes/stats

Authentication

Same as above:

    • x-api-key & x-api-secret headers



       

Query Parameters

Param

Type

Description

skip

Number (optional)

Records to skip

limit

Number (required)

Max records to return (⚠️ max 200 with skip)

groupName

String (optional)

Must be one of:• חתם• נון שופ• ייפוי כח• הערת אזהרה



Request Body (JSON)

{

  "status": [1, 2, 3],

  "drivers": "<ObjectId>",

  "orgId": ["<ObjectId>"]

}



Example Request
curl --location --request POST 'https://app.getstatus.online/api/exposed/routes/stats?limit=20&skip=10' \--header 'x-api-key: KEY' \
--header 'x-api-secret: SECRET' \
--header 'Content-Type: application/json' \
--data-raw '{
"status": [1],
 "orgId": ["64ab0c1234567890abcdef12"]
}'



Example Response

{

  "routeStats": [

    {

      "_id": "67a5fe1912857eb16e3d60ab",

      "name": "account archive 3806",

      "apartments": 0,

      "totalSigned": 0,

      "totalSignedPer": 0,

      "totalPublic": 0,

      "totalPublicPer": 0,

      "totalPartialSignature": 0,

      "totalPartialSignedPer": 0,

      "apartments_public": 0,

      "totalSigned_public": 0,

      "totalSigned_public_partial": 0,

      "totalSignedPer_public": 0,

      "totalSignedPartialPublicPer": 0

    }

  ],

  "totalRoutes": 4002

}

📊 Fetch invites of a Route

POST https://app.getstatus.online/api/exposed/users

 

Authentication

Same as above:

  • x-api-key & x-api-secret headers



Query Parameters

Param

Type

Description

skip

Number (optional)

Records to skip

limit

Number (required)

Max records to return⚠️ limit - skip must not exceed 200

search

String (Optional)

Query to search from name or email

 



Request Body (JSON)

{

    "routeId": "<RouteId>",

    "filters": [

{

            "columnName": "<column name on which filter should be applied>",

            "values": [ “<value we need to filter>” ]

        }],

    "sortedColumns": [

{

            "field": "<Field name on which sorting should be applied>",

            "order": "<asc or desc>"

        }

]

}




 Example Request

curl --location https://app.getstatus.online/api/exposed/users?skip=0&limit=100&search=fresh' \

--header 'x-api-key: KEY' \

--header 'x-api-secret: -SECRET' \

--header 'Content-Type: application/json' \

--data '{

    "routeId": "689dbe4782d924fad250d32e",

    "sortedColumns": [

        {

            "field": "firstName",

            "order": "desc"

        }

    ],

    "filters": [

        {

            "columnName": "fullName",

            "values": [

                "fresh user"

            ]

        }

    ]

}'





 Example Response

{

    "users": [

        {

            "firstName": "fresh",

            "lastName": "user",

            "email": "examplehomeowner@gmail.com",

            "cellPhone": "",

            "country": "IL",

            "language": "en",

            "metadata": [],

            "notes": "מתגורר בדירה, מעוניין בפרויקט, שאל על אפשרות למכור את הדירה",

            "labels": [],

            "isContact": false

        }

    ],

    "totalUsers": 1

}