storEDGE API Documentation

Discussion

Returns the same-day vacates of facilities based on given date filters. The results are sorted by store_number, unit_name, and updated_at (action_at) in ascending order.
The default page size is 500 results with a maximum of 2,000 results per page.

>>>

GET /v1/companies/:company_id/same_day_vacates
Returns the units with move-out and move-in events on the same day

Examples

GET /v1/companies/7080ac59-4366-4a77-b425-79071b0b353a/same_day_vacates
200
{
  "same_day_vacates": [
    {
      "id": "0b2f9b06-e54b-43fa-8b75-05dcea3b4fa3",
      "store_number": 110,
      "unit_name": "0079",
      "tenant_id": 9085324,
      "tenant_name": "Ethan Smith",
      "action": "vacate",
      "action_at": "2023-09-26T03:51:54-10:00",
      "action_by": "Olivia Johnson"
    },
    {
      "id": "48a192e5-a002-420f-a64b-c7ff7218b664",
      "store_number": 110,
      "unit_name": "0079",
      "tenant_id": 9103983,
      "tenant_name": "Liam Brown",
      "action": "rental",
      "action_at": "2023-09-26T04:56:19-10:00",
      "action_by": "Olivia Johnson"
    },
    {
      "id": "027982b0-1c44-4949-9ff5-80dde933b88e",
      "store_number": 118,
      "unit_name": "4158",
      "tenant_id": 7827571,
      "tenant_name": "Benjamin Davis",
      "action": "vacate",
      "action_at": "2023-09-26T07:28:21-10:00",
      "action_by": "Sophia Clark"
    },
    {
      "id": "cc8fc7f1-b6e6-4440-b696-224586acf1ca",
      "store_number": 118,
      "unit_name": "4158",
      "tenant_id": 8681687,
      "tenant_name": "Martin Mason",
      "action": "rental",
      "action_at": "2023-09-26T07:37:24-10:00",
      "action_by": "Sophia Clark"
    },
    {
      "id": "edf95241-aaa6-41ba-a14d-30bf32442a69",
      "store_number": 163,
      "unit_name": "B209",
      "tenant_id": 9016650,
      "tenant_name": "Ethan Wilson",
      "action": "vacate",
      "action_at": "2023-09-26T06:45:24-10:00",
      "action_by": "Benjamin Davis Johnson"
    },
    {
      "id": "27a53aac-93d7-4d1a-80c5-54ad6e9d9841",
      "store_number": 163,
      "unit_name": "B209",
      "tenant_id": 9104542,
      "tenant_name": "John Smith",
      "action": "rental",
      "action_at": "2023-09-26T07:20:56-10:00",
      "action_by": "Benjamin Davis Johnson"
    },
    {
      "id": "3973f974-cd45-4a0e-aed1-f57374212b4a",
      "store_number": 295,
      "unit_name": "C369",
      "tenant_id": 8964895,
      "tenant_name": "Liam Smith",
      "action": "vacate",
      "action_at": "2023-09-26T11:54:51-10:00",
      "action_by": "Olivia Wilson"
    },
    {
      "id": "689c5baf-326e-438f-a370-6b6061c28bfc",
      "store_number": 295,
      "unit_name": "C369",
      "tenant_id": 7910511,
      "tenant_name": "Sophia Brown",
      "action": "rental",
      "action_at": "2023-09-26T12:03:00-10:00",
      "action_by": "Olivia Wilson"
    },
    {
      "id": "bd22c5a7-a93f-4f34-9939-b2e303b08e9b",
      "store_number": 325,
      "unit_name": "B48",
      "tenant_id": 8944632,
      "tenant_name": "Mason Clark",
      "action": "vacate",
      "action_at": "2023-09-26T08:39:20-10:00",
      "action_by": "Emma Martin"
    },
    {
      "id": "a8e73955-fa7a-4d84-bb82-0a0db4704b9e",
      "store_number": 325,
      "unit_name": "B48",
      "tenant_id": 9102299,
      "tenant_name": "Liam Johnson",
      "action": "rental",
      "action_at": "2023-09-26T08:54:23-10:00",
      "action_by": "Emma Martin"
    },
    {
      "id": "faa14116-2217-429f-9846-b2f477fe3940",
      "store_number": 4601,
      "unit_name": "1163",
      "tenant_id": 8991012,
      "tenant_name": "Ethan Clark",
      "action": "vacate",
      "action_at": "2023-09-26T05:20:00-10:00",
      "action_by": "Ethan Wilson"
    },
    {
      "id": "9bf0bac3-15ce-472d-a0bc-584446e5f088",
      "store_number": 4601,
      "unit_name": "1163",
      "tenant_id": 7843678,
      "tenant_name": "Liam Clark",
      "action": "rental",
      "action_at": "2023-09-26T10:20:26-10:00",
      "action_by": "Martin Johnson"
    },
    {
      "id": "e4bd4dd0-4364-4333-8a2d-41e5bf848db2",
      "store_number": 4601,
      "unit_name": "1163",
      "tenant_id": 7843678,
      "tenant_name": "Liam Clark",
      "action": "vacate",
      "action_at": "2023-09-26T10:38:28-10:00",
      "action_by": "Martin Johnson"
    },
    {
      "id": "d5d7f1ca-eb04-460c-a519-affb12870d09",
      "store_number": 4601,
      "unit_name": "1163",
      "tenant_id": 9105298,
      "tenant_name": "Benjamin Martin",
      "action": "rental",
      "action_at": "2023-09-26T10:46:35-10:00",
      "action_by": "Martin Johnson"
    }
  ],
  "meta": {
    "pagination": {
      "current_page": 1,
      "total_pages": 1,
      "per_page": 500,
      "total_entries": 14,
      "previous_page": null,
      "next_page": null
    },
    "filters": {},
    "sorting": null,
    "search_term": null,
    "status_code": 200,
    "status_message": "OK",
    "status_cat": "https://http.cat/200",
    "request_method": "GET",
    "request_id": "24126543-6a5c-4d0a-ae32-4afc7e31727e",
    "parameters": {
      "start_date": "2023-09-26",
      "end_date": "2023-09-26",
      "company_id": "7080ac59-4366-4a77-b425-79071b0b353a"
    }
  }
}

Params

Param name	Description
company_id required	The company id Value: Must be a String
start_date required	The date after which same-day vacates will be returned. Used with `end_date` and format should be YYYY-MM-DD (e.g. 2023-07-16) Value: Must be a Date
end_date required	The date before which same-day vacates will be returned. Used with `start_date` and format should be YYYY-MM-DD (e.g. 2023-07-16) Value: Must be a Date

Same day vacates

Discussion

GET /v1/companies/:company_id/same_day_vacates Returns the units with move-out and move-in events on the same day

Examples

Params

GET /v1/companies/:company_id/same_day_vacates
Returns the units with move-out and move-in events on the same day