Skip to main content
GET
/
v1
/
planning
/
sources
/
{sourceIds}
Get planning applications by source IDs
curl --request GET \
  --url https://api.vepler.com/v1/v1/planning/sources/{sourceIds} \
  --header 'x-api-key: <api-key>'
{
  "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.

Path Parameters

sourceIds
string
required

Comma-separated list of source IDs (e.g., council-a::APP/2024/0001)

Response

Planning application data successfully retrieved

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