V3 API

Authentication

To get an API key open a user detail and click "Generate API key".

To authenticate the request incude a hader with name "key" and the api key as the value.

For example: curl -H "key: {apiKey}" "https://dev.v3manager.com/demo/api/customer"

Dates

Dates are always expressed in the tenant local time. Both ISO and unix formats are supported. For example 2024-01-20T20:00:00 or 1705777200.

Filters

To filter list requests the format is [field, operator, value]. For example:

https://dev.v3manager.com/demo/api/sale?search=["created",">","05-07-2023"]

URL encoded would be:

https://dev.v3manager.com/demo/api/sale?search=%5B%22created%22%2C%22%3E%22%2C%2205-07-2023%22%5D"

Filter by null:

["end","=",null]

Include deleted records:

["deleted","in",[0,1]]

Nest filters:

["OR", ["status","in",[3,4]], ["price","=",0]]

Example: filter records created or updated since a date

["OR", ["created",">","2023-07-01"], ["updated",">","2023-07-01"]]

URL encoded would be:

curl -H "key: {apiKey}" "http://localhost:8080/demo/api/booking?search=%5B%22OR%22%2C%20%5B%22created%22%2C%22%3E%22%2C%222023-07-01T00%3A00%22%5D%2C%20%5B%22updated%22%2C%22%3E%22%2C%222023-07-01T00%3A00%22%5D%5D"

Fields

You can specify the fields that you want in the response. The id field is always present

https://dev.v3manager.com/demo/api/sale?fields=["description", "total"]

Response example

{ "description": "Coca Cola", "id": 1391, "total": 2 }, { "description": "Aquarius", "id": 1392, "total": 2.42 }

Limit results

To limit the maximum number or results:

https://dev.v3manager.com/demo/api/sale?limit=10

Sort results

To sort results:

https://dev.v3manager.com/demo/api/sale?sort=["id DESC"]

Endpoints