Parkalot API (0.3.1)

Download OpenAPI specification:Download

E-mail: admin@parkalot.io URL: https://parkalotapi.io/

API for integration of 3rd party applications or systems with Parkalot.

Reports

Endpoints for retrieving parking reports

Query parking reports in human and machine readable format.

Retrieve parking reports for a specified date range.

For optimal performance and to conserve API quota, it's recommended to query only the specific dates needed (e.g., single days, weeks, or months at a time). While there's no strict limit on the date range, frequent queries over long durations may deplete your API quota quickly.

Authorizations:

ApiKeyAuth

path Parameters

facilityId required	string (FacilityId) Example: x0CO2RdMTYIXPzpQD1ysDWN14wj3 The identifier of an office, car park or any other site.
fromDay required	string <date> (Date) Example: 2023-07-15 Start date in YYYY-MM-DD format. Must be before or equal to toDay.
toDay required	string <date> (Date) Example: 2023-07-15 End date in YYYY-MM-DD format. Must be after or equal to fromDay.

Responses

Response samples

Content type

application/json

{"query": {"parking_id": "central-parking-01",
"start_day": "2023-07-15",
"end_day": "2023-07-15"
},
"data": [{"day": "2023-07-15",
"start_time": "14:00:00",
"end_time": "16:30:00",
"item_name": "Parking Spot A1",
"item_id": 17,
"item_group_id": 4,
"item_group_name": "Shared",
"user_id": "7f8e9d6c5b4a3f2e",
"user_name": "Mike Spencer",
"owner_id": "1a2b3c4d5e6f7g8h",
"owner_name": "Oliver Thompson",
"released_at": {"relative_millis": -36000000,
"day_time": "23:00:00",
"day_offset": -1
},
"reserved_at": {"relative_millis": 5400000,
"day_time": "01:30:00",
"day_offset": 0
}
},
{"day": "2023-07-15",
"start_time": "10:00:00",
"end_time": "18:30:00",
"item_name": "Parking Spot A2",
"item_id": 18,
"item_group_id": 4,
"item_group_name": "Shared",
"user_id": "3f2e7f8ec5b4a9d6",
"user_name": "Paul Hill",
"owner_id": null,
"owner_name": null,
"released_at": null,
"reserved_at": {"relative_millis": 5400000,
"day_time": "01:30:00",
"day_offset": 0
}
}
]
}

Reservations

Endpoints for retrieving reservations

Query reservations in human and machine readable format.

Retrieve reservations for a specified date range.

The limit is set to 31 days

Authorizations:

ApiKeyAuth

path Parameters

facilityId required	string (FacilityId) Example: x0CO2RdMTYIXPzpQD1ysDWN14wj3 The identifier of an office, car park or any other site.
fromDay required	string <date> (Date) Example: 2023-07-15 Start date in YYYY-MM-DD format. Must be before or equal to toDay.
toDay required	string <date> (Date) Example: 2023-07-15 End date in YYYY-MM-DD format. Must be after or equal to fromDay.

query Parameters

item_tags	boolean Default: false Include item tags in the response
item_description	boolean Default: false Include item description in the response
item_group_id	boolean Default: false Include item group id in the response
item_group_name	boolean Default: false Include item group name in the response

Responses

Response samples

Content type

application/json

{"data": [{"day": "2023-07-15",
"item_id": "17",
"item_name": "Parking Spot A17",
"times": [{"start_time": "14:00:00",
"end_time": "16:30:00",
"user": {"user_id": "7f8e9d6c5b4a3f2ed6c5b434",
"user_name": "Mike Spencer",
"user_external_id": "7189",
"user_plates": ["ABC123",
"XYZ456"
]
}
},
{"start_time": "17:00:00",
"end_time": "18:30:00",
"user": {"user_id": "3f2e7f8ec5b4a9d6",
"user_name": "Paul Hill",
"user_external_id": "7190",
"user_plates": ["DEF789",
"GHI012"
]
}
}
],
"item_tags": ["tag1",
"tag2"
],
"item_description": "Parking spot near the entrance",
"item_group_id": 4,
"item_group_name": "Shared"
}
],
"query": {"parking_id": "x0CO2RdMTYIXPzpQD1ysDWN14wj3",
"start_day": "2023-07-15",
"end_day": "2023-07-15"
}
}

Query reservations in human and machine readable format - flat structure.

Retrieve reservations for a specified date range.

The limit is set to 31 days

Authorizations:

ApiKeyAuth

path Parameters

facilityId required	string (FacilityId) Example: x0CO2RdMTYIXPzpQD1ysDWN14wj3 The identifier of an office, car park or any other site.
fromDay required	string <date> (Date) Example: 2023-07-15 Start date in YYYY-MM-DD format. Must be before or equal to toDay.
toDay required	string <date> (Date) Example: 2023-07-15 End date in YYYY-MM-DD format. Must be after or equal to fromDay.

query Parameters

item_tags	boolean Default: false Include item tags in the response
item_description	boolean Default: false Include item description in the response
item_group_id	boolean Default: false Include item group id in the response
item_group_name	boolean Default: false Include item group name in the response

Responses

Response samples

Content type

application/json

{"data": [{"day": "2023-07-15",
"item_id": "17",
"item_name": "Parking Spot 17",
"start_time": "14:00:00",
"end_time": "16:30:00",
"user": {"user_id": "7f8e9d6c5b4a3f2ed6c5b434",
"user_name": "Mike Spencer",
"user_external_id": "7189",
"user_plates": ["ABC123",
"XYZ456"
]
},
"item_tags": ["tag1",
"tag2"
],
"item_description": "Parking spot near the entrance",
"item_group_id": 4,
"item_group_name": "Shared"
}
],
"query": {"parking_id": "x0CO2RdMTYIXPzpQD1ysDWN14wj3",
"start_day": "2023-07-15",
"end_day": "2023-07-15"
}
}

Check for reservation changes since a specific timestamp.

Check if there were any changes to reservations or parking setup within the specified date range since a given timestamp.

Authorizations:

ApiKeyAuth

path Parameters

facilityId required	string (FacilityId) Example: x0CO2RdMTYIXPzpQD1ysDWN14wj3 The identifier of an office, car park or any other site.
fromDay required	string <date> (Date) Example: 2023-07-15 Start date in YYYY-MM-DD format. Must be before or equal to toDay.
toDay required	string <date> (Date) Example: 2023-07-15 End date in YYYY-MM-DD format. Must be after or equal to fromDay.

query Parameters

since

required

integer <int64>

Example: since=1689420000000

Unix timestamp in milliseconds.

Responses

Response samples

Content type

application/json

{"hasChanges": true,
"changes": [{"day": "2023-07-15",
"changed": true
},
{"day": "2023-07-16",
"changed": false
}
]
}

Update reservations in batch.

This endpoint manages parking spot reservations, allowing both reservation creation and release.

Request Payload: - An array of reservation action objects, each representing a reservation or release action for a specific parking spot and time slot.

Functionality:

Reserve Time Slots:
- To reserve time slots, provide a valid user ID (uid) in the reservation action object.
- The uid field must be a non-null string value.
Unreserve Time Slots:
- To release (unreserve) time slots, set the uid to null in the reservation action object.
Combined Reserve and Unreserve:
- Each reservation action object in the array can independently reserve or release time slots based on the presence or absence of a uid.
- You can include both reserve and unreserve actions in the same request payload.

Note: Partially releasing spot with an ownership results with confirming other shifts

Authorizations:

ApiKeyAuth

path Parameters

facilityId

required

string (FacilityId)

Example: x0CO2RdMTYIXPzpQD1ysDWN14wj3

The identifier of an office, car park or any other site.

Request Body schema: application/json
required

Array

uid	string For example "7f8e9d6c5b4a3f2ed6c5b434"
	string or integer For example "3" or 3
day	string <date> (Date) Date in YYYY-MM-DD format
shifts	Array of strings (Shift)
withWaitlist	boolean or null If true, unreserving a spot will trigger the waitlist

Responses

Request samples

Payload

Content type

application/json

[{"uid": "string",
"spotId": "string",
"day": "2023-07-15",
"shifts": ["00002400"
],
"withWaitlist": true
}
]

Response samples

Content type

application/json

[{"success": true,
"data": {"uid": "string",
"spotId": "string",
"day": "2023-07-15",
"shifts": ["00002400"
],
"withWaitlist": true
}
}
]

Delete reservations for a specific date range and user.

Delete reservations for a specific date range and user.

The limit is set to 31 days.

At least one user identifier (uid, externalId, or email) must be provided.

Authorizations:

ApiKeyAuth

path Parameters

facilityId required	string (FacilityId) Example: x0CO2RdMTYIXPzpQD1ysDWN14wj3 The identifier of an office, car park or any other site.
fromDay required	string <date> (Date) Example: 2023-07-15 Start date in YYYY-MM-DD format. Must be before or equal to toDay.
toDay required	string <date> (Date) Example: 2023-07-15 End date in YYYY-MM-DD format. Must be after or equal to fromDay.

query Parameters

uid	string Example: uid=7f8e9d6c5b4a3f2ed6c5b434 User ID to delete reservations for
externalId	string Example: externalId=7189 External user ID to delete reservations for
email	string Example: email=mike.spencer@acme.com User email to delete reservations for
withWaitlist	boolean Example: withWaitlist=true If true, unreserving a spot will trigger the waitlist

Responses

Response samples

Content type

application/json

{"success": true
}

Parkalot API (0.3.1)

Reports

Query parking reports in human and machine readable format.

Authorizations:

path Parameters

Responses

Response samples

Reservations

Query reservations in human and machine readable format.

Authorizations:

path Parameters

query Parameters

Responses

Response samples

Query reservations in human and machine readable format - flat structure.

Authorizations:

path Parameters

query Parameters

Responses

Response samples

Check for reservation changes since a specific timestamp.

Authorizations:

path Parameters

query Parameters

Responses

Response samples

Update reservations in batch.

Authorizations:

path Parameters

Request Body schema: application/jsonrequired

Responses

Request samples

Response samples

Delete reservations for a specific date range and user.

Authorizations:

path Parameters

query Parameters

Responses

Response samples

Request Body schema: application/json
required