Programmatically issue permits, validate plates, and access Offstreet data
The Offstreet OpenAPI allows your system to connect with Offstreet in real time to issue permits, validate licence plates, and access location or event data. The API is REST-based, well-documented, and easy to work with.
View the full documentation here: Offstreet OpenAPI on SwaggerHub
Overview
With Offstreet’s OpenAPI, you can:
- Programmatically create and manage parking permits
- Validate licence plates during enforcement
- Retrieve Offstreet locations and event data
- Seamlessly integrate Offstreet with other systems (e.g., CRMs, kiosks, gate access tools)
What You’ll Need
| Requirement | Description | Who Provides It |
|---|---|---|
| API Key (Bearer Token) | Used to authenticate your API requests | Offstreet |
| API Base URL | Separate endpoints for sandbox and production environments | Offstreet |
| Developer or Integrator | Someone on your team to implement the API | You |
Step-by-Step Setup
1. Request API Access
Reach out to your Offstreet account manager or support@joinoffstreet.com to request:
- Your API Key (Bearer token)
- The Base URL for your environment (sandbox or production)
2. Review Available Endpoints
Key endpoints include:
| Endpoint | Description |
|---|---|
POST /permits | Create a new permit |
GET /locations | Fetch a list of Offstreet locations |
GET /enforcement/validate | Check if a licence plate has a valid permit |
GET /events | Retrieve event data related to permit activity |
Each endpoint includes full Swagger documentation with required fields, sample payloads, and response examples.
3. Authenticate API Requests
All requests must include your Bearer token in the header.
4. Test and Integrate
You can test the API directly in SwaggerHub using the "Try it out" feature.
Once your integration is ready, you can:
- Create permits from a CRM, kiosk, gate, or other source
- Validate licence plates in real-time enforcement workflows
- Sync Offstreet data to other systems
The Offstreet OpenAPI lets approved partners securely access live parking data from the Offstreet platform. It’s designed for integrations — so partners can view parking sessions, permits, and locations in real time, without manual data sharing.
What’s Available
| Category | What It Is | What You Can See | Typical Use |
|---|---|---|---|
| Locations | All parking sites a company manages in Offstreet. | Name, address, ID, city, state, timezone. | Map Offstreet’s sites to your own zones or lots. |
| Parking Sessions | Every instance of a vehicle parking at a location. | License plate, state, start/end time, location, permit ID, status, created date/time. | See who’s parked right now, run reports, or track activity. |
| Search by Plate | Find all parking sessions for a specific license plate. | Plate, state, location, start/end time, permit ID, active/inactive status. | Quickly check if a vehicle has a valid permit or active session. |
| Permits | A summary of all sessions linked to a single parking permit. | Permit ID, related plates, times, and locations. | Understand how a permit is being used (e.g. by multiple vehicles or sites). |
| Filters & Ranges | Ways to narrow down data to what you need. | Active only, date range, or sessions created after a specific time. | View only current parkers or activity for a specific day or timeframe. |
How It Fits Together
- Permit → Sessions: Each permit can include multiple sessions (e.g., if it covers more than one vehicle or site).
- Session → Vehicle: Each session is one car, one time, one location.
- Plate & Location: Primary lookup paths — e.g., “show me everything for plate ABC123” or “everything at Downtown Garage.”
Secure & Simple
- Access requires an API key provided by Offstreet.
- All data is read-only — partners can view, not edit.
- Partners only see data for their authorized company and locations.
- Data is updated in real time and delivered securely over HTTPS.
Quick Reference: Common Questions Answered
| If you want to know... | The API gives you... |
|---|---|
| Which vehicles are parked right now? | Current parking sessions (by location). |
| Does this plate have a valid permit? | Plate search results showing active sessions. |
| What sites can I pull data from? | The list of authorized locations. |
| When did this vehicle park last week? | Sessions filtered by date range. |
| How has this permit been used? | Sessions linked to a specific permit ID. |
What’s Not Shared via the OpenAPI
| Category | Not Shared | Why |
|---|---|---|
| Personal information | Names, emails, phone numbers, account info | Privacy and data-sharing compliance (PII excluded). |
| Payment data | Fees, payment methods, receipts, refund details | Security, PCI compliance, and relevance — most partners don’t process payments through Offstreet. |
| Permit metadata | Permit type, additional information, custom fields, internal notes | Simplifies the data model; keeps payloads lightweight and consistent. |
Need Help?
Reach out to your Offstreet Account Manager or Contact Support if you:
- Need help setting up your credentials or environment
- Have questions about how to use a specific endpoint
- Encounter issues during testing or implementation
Was this article helpful?
That’s Great!
Thank you for your feedback
Sorry! We couldn't be helpful
Thank you for your feedback
Feedback sent
We appreciate your effort and will try to fix the article