Skip to main content
POST
/
v1
/
planning
/
query
Query planning applications with advanced filters
curl --request POST \
  --url https://api.vepler.com/v1/v1/planning/query \
  --header 'Content-Type: application/json' \
  --header 'x-api-key: <api-key>' \
  --data '
{
  "query": {
    "councils": [
      "<string>"
    ],
    "key": "<string>",
    "statuses": [
      "<string>"
    ],
    "types": [
      "<string>"
    ],
    "developmentCategories": [
      "<string>"
    ],
    "receivedDateFrom": "<string>",
    "receivedDateTo": "<string>",
    "validatedDateFrom": "<string>",
    "validatedDateTo": "<string>",
    "appealedDateFrom": "<string>",
    "appealedDateTo": "<string>"
  },
  "limit": 50,
  "offset": 0,
  "sortBy": "receivedDate",
  "sortOrder": "desc"
}
'
{
  "success": true,
  "applications": [
    {
      "id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
      "provider": "<string>",
      "key": "<string>",
      "sourceId": "<string>",
      "status": "received",
      "createdAt": "<string>",
      "updatedAt": "<string>",
      "statusExternal": "<string>",
      "statusConfidence": 123,
      "type": "<string>",
      "typeExternal": "<string>",
      "developmentCategory": "<string>",
      "typeConfidence": 123,
      "description": "<string>",
      "receivedDate": "<string>",
      "validatedDate": "<string>",
      "appealedDate": "<string>",
      "appealedStatus": "<string>",
      "spatial": {
        "type": "Point",
        "coordinates": [
          123
        ]
      },
      "spatialFeatures": "<unknown>"
    }
  ],
  "total": 123,
  "limit": 123,
  "offset": 123
}

Authorizations

x-api-key
string
header
required

API Key authentication for Vepler API. Get your API key from the Vepler dashboard.

Body

application/json

Planning application search criteria

query
object
limit
number
default:50
Required range: 1 <= x <= 100
offset
number
default:0
Required range: x >= 0
sortBy
enum<string>
default:receivedDate
Available options:
receivedDate,
validatedDate,
appealedDate,
createdAt,
updatedAt
sortOrder
enum<string>
default:desc
Available options:
asc,
desc

Response

Planning applications matching search criteria

success
enum<boolean>
required
Available options:
true,
false
applications
object[]
required
total
number
required
limit
number
required
offset
number
required