# Overview

The ParqEx API is organized around [REST](http://en.wikipedia.org/wiki/Representational_State_Transfer). Our API has predictable resource-oriented URLs, accepts [form-encoded](https://en.wikipedia.org/wiki/POST_\(HTTP\)#Use_for_submitting_web_forms) request bodies, returns [JSON-encoded](http://www.json.org/) responses, and uses standard HTTP response codes, authentication, and verbs.

You can use the ParqEx API in test mode, which does not affect your live data, access controllers or interact with the banking networks. The API URL and key you use to [authenticate](/-MUyxAVrX9S4wky8UoX6/oauth/how-to-authorize-access.md) the request are tied to the live mode or test mode.

The ParqEx API differs for every account as we release new versions and tailor functionality.

\-----------------------------------------------------------------------------------------------------

With approved access to the ParqEx API, you can leverage the following capabilities:

An ***Admin*** can:

* Marketplace (Owner functionality): Manage listing information, availability, price, publish/unpublish listings, etc.
* Marketplace (Renter functionality): Book parking, manage vehicle lists, manage user profiles.
* GuestParq & GuestAccess: Manage guest lists, Transfer reservations to guests, manage access.
* Access+: Operate any access point on their account, manage permissions, guest & vehicle information. 
* Enforcer: Manage DO NOT TOW vehicle lists, manage parking notices, update parking notice status.

A ***User*** can:

* Marketplace (Renter Only): View properties, reserve and pay for parking, view orders, manage notification preferences, manage their personal profile and vehicle information. 
* GuestParq & GuestAccess: Manage their profile, notification preferences, Reserve or transfer their parking to guests/visitors, Depending on their permission level they may be able to give access to certain doors. 
* Access+: Operate access points (doors, gates, garage, elevators, etc.). Avail LPR with Access+ services to gain access to parking areas.

## Modules & Functions accessible via the API: 

1. User: Create and manage user profile, 
2. Notification: Notification settings (Push, Email, & SMS).
3. Vehicle: Vehicle management.
4. Orders: Order management & history.
5. Guest / Visitor: user information, access control, and vehicle management.
6. Access control: user management & logs. 
7. Enforcement: violation management.

## Endpoints

{% content-ref url="/pages/-MUxXfMAl7i8CIYcA9OJ" %}
[Get User Info](/-MUyxAVrX9S4wky8UoX6/api-endpoints/get-user-info.md)
{% endcontent-ref %}

{% content-ref url="/pages/-MUxZ0kPb6u3hkQN-wCk" %}
[Get User Settings](/-MUyxAVrX9S4wky8UoX6/api-endpoints/get-user-settings.md)
{% endcontent-ref %}

{% content-ref url="/pages/-MUtLPNQd8SmuUHcjSWA" %}
[Get User Devices](/-MUyxAVrX9S4wky8UoX6/api-endpoints/get-user-devices.md)
{% endcontent-ref %}

{% content-ref url="/pages/-MUtUyzvQiXs3OkKeOH8" %}
[Invite User (internal)](/-MUyxAVrX9S4wky8UoX6/api-endpoints/invite-user-internal.md)
{% endcontent-ref %}

{% content-ref url="/pages/-MUtRCNxf6m3cjhPJEql" %}
[Toggle Access Point](/-MUyxAVrX9S4wky8UoX6/api-endpoints/toggle-access-point.md)
{% endcontent-ref %}

{% content-ref url="/pages/-MUtV2-BCibOs6307\_qM" %}
[Get Access History](/-MUyxAVrX9S4wky8UoX6/api-endpoints/get-access-history.md)
{% endcontent-ref %}


---

# Agent Instructions: Querying This Documentation

If you need additional information that is not directly available in this page, you can query the documentation dynamically by asking a question.

Perform an HTTP GET request on the current page URL with the `ask` query parameter:

```
GET https://docs.parqex.com/-MUyxAVrX9S4wky8UoX6/api-endpoints/overview.md?ask=<question>
```

The question should be specific, self-contained, and written in natural language.
The response will contain a direct answer to the question and relevant excerpts and sources from the documentation.

Use this mechanism when the answer is not explicitly present in the current page, you need clarification or additional context, or you want to retrieve related documentation sections.