Endpoint Specifications - Digital Planning Data Schemas

Public Endpoints

Public endpoints return redacted data suitable for public access.

Get Published Applications

curl -X GET \
  -H "Content-Type: application/json" \
  -H "x-client: camden" \
  -H "x-service: documentation-example" \
  "https://api.example.com/api/@next/public/applications?page=1&resultsPerPage=10"

Query Parameters

page

number

default:"1"

required

Current page number (1-indexed in API, 0-indexed internally)

resultsPerPage

number

default:"10"

required

Number of results per page

query

string

Search across reference, description, and address fields

reference

string

Filter by application reference number

sortBy

string

default:"receivedAt"

Sort fieldOptions: publishedAt, receivedAt

orderBy

string

default:"desc"

Sort orderOptions: asc, desc

Response

data

PostSubmissionPublishedApplication[]

Array of published applications

pagination

Pagination

Pagination metadata

Get Published Application

Retrieve a single published application by ID.

curl -X GET \
  -H "Content-Type: application/json" \
  -H "x-client: camden" \
  -H "x-service: documentation-example" \
  "https://api.example.com/api/@next/public/applications/ABC-2024-001"

Path Parameters

applicationId

string

required

Unique application identifier or reference number

Response

data

PostSubmissionPublishedApplication

Single published application object

Get Published Documents

Retrieve documents for a specific application.

curl -X GET \
  -H "Content-Type: application/json" \
  -H "x-client: camden" \
  -H "x-service: documentation-example" \
  "https://api.example.com/api/@next/public/applications/ABC-2024-001/documents?page=1&resultsPerPage=10"

Path Parameters

applicationId

string

required

Unique application identifier

Query Parameters

page

number

default:"1"

required

Current page number

resultsPerPage

number

default:"10"

required

Number of results per page

name

string

Filter by document name

type

string

Filter by document typeExamples: floorPlan.existing, elevations.proposed, designAndAccessStatementSee Document Types for full list

sortBy

string

default:"publishedAt"

Sort fieldOptions: publishedAt, name

orderBy

string

default:"desc"

Sort orderOptions: asc, desc

publishedAtFrom

datetime

Filter documents published after this datetimeFormat: ISO 8601 UTC (e.g., 2024-01-01T00:00:00Z)

publishedAtTo

datetime

Filter documents published before this datetime

Response

data

PostSubmissionFile[]

Array of document objects

Show PostSubmissionFile properties

number

Document ID

name

string

Document name

type

string[]

Document types/categories

association

string

File association: application, appeal, specialistComment, publicComment

version

number

Document version number

thumbnailUrl

string

URL to document thumbnail

description

string

Document description

metadata

object

Document metadata including size, mimeType, timestamps

Get Published Document

Retrieve a single document by ID.

curl -X GET \
  -H "Content-Type: application/json" \
  -H "x-client: camden" \
  -H "x-service: documentation-example" \
  "https://api.example.com/api/@next/public/applications/ABC-2024-001/documents/123"

Path Parameters

applicationId

string

required

Unique application identifier

documentId

number

required

Document ID

Response

data

PostSubmissionFile

Single document object

Get Published Public Comments

Retrieve public (neighbour) comments for an application.

curl -X GET \
  -H "Content-Type: application/json" \
  -H "x-client: camden" \
  -H "x-service: documentation-example" \
  "https://api.example.com/api/@next/public/applications/ABC-2024-001/publicComments?page=1&resultsPerPage=10"

Path Parameters

applicationId

string

required

Unique application identifier

Query Parameters

page

number

default:"1"

required

Current page number

resultsPerPage

number

default:"10"

required

Number of results per page

query

string

Search comment text

sentiment

string

Filter by sentimentOptions: objection, neutral, supportiveSupports AND/OR filtering

topic

string

Filter by topicOptions: design, use, light, privacy, access, noise, traffic, otherSupports AND/OR filtering

publishedAtFrom

datetime

Filter comments published after this datetime

publishedAtTo

datetime

Filter comments published before this datetime

sortBy

string

default:"publishedAt"

Sort field (currently only publishedAt supported)

orderBy

string

default:"desc"

Sort order: asc, desc

Response

data

PublicComment[]

Array of public comment objects

Get Published Public Comment

Retrieve a single public comment.

curl -X GET \
  -H "Content-Type: application/json" \
  -H "x-client: camden" \
  -H "x-service: documentation-example" \
  "https://api.example.com/api/@next/public/applications/ABC-2024-001/publicComments/456"

Path Parameters

applicationId

string

required

Unique application identifier

publicCommentId

string

required

Public comment ID

Response

data

PublicComment

Single public comment object

Get Published Specialist Comments

Retrieve specialist (consultee) comments for an application.

curl -X GET \
  -H "Content-Type: application/json" \
  -H "x-client: camden" \
  -H "x-service: documentation-example" \
  "https://api.example.com/api/@next/public/applications/ABC-2024-001/specialistComments?page=1&resultsPerPage=10"

Path Parameters

applicationId

string

required

Unique application identifier

Query Parameters

page

number

default:"1"

required

Current page number

resultsPerPage

number

default:"10"

required

Number of results per page

query

string

Search comment text

sentiment

string

Filter by sentimentOptions: approved, amendmentsNeeded, objectedSupports AND/OR filtering

publishedAtFrom

datetime

Filter comments published after this datetime

publishedAtTo

datetime

Filter comments published before this datetime

sortBy

string

default:"publishedAt"

Sort field (currently only publishedAt supported)

orderBy

string

default:"desc"

Sort order: asc, desc

Response

data

SpecialistComment[]

Array of specialist comment objects

Get Published Specialist

Retrieve comments from a specific specialist.

curl -X GET \
  -H "Content-Type: application/json" \
  -H "x-client: camden" \
  -H "x-service: documentation-example" \
  "https://api.example.com/api/@next/public/applications/ABC-2024-001/specialistComments/789?page=1&resultsPerPage=10"

Path Parameters

applicationId

string

required

Unique application identifier

specialistId

string

required

Specialist ID

Query Parameters

page

number

default:"1"

required

Current page number

resultsPerPage

number

default:"10"

required

Number of results per page

Response

data

SpecialistComment[]

Array of comments from the specified specialist

Private Endpoints

Private endpoints require authentication and return unredacted data with sensitive information.

Get Applications

Retrieve unredacted applications (private endpoint).

curl -X GET \
  -H "Content-Type: application/json" \
  -H "x-client: camden" \
  -H "x-service: documentation-example" \
  "https://api.example.com/api/@next/applications?page=1&resultsPerPage=10"

This endpoint follows the same parameter structure as the public applications endpoint but returns unredacted data.

Send Public Comment

Submit a new public comment.

curl -X POST \
  -H "Content-Type: application/json" \
  -H "x-client: camden" \
  -H "x-service: documentation-example" \
  -d '{"comment": "I object to this application", "sentiment": "objection"}' \
  "https://api.example.com/api/@next/applications/ABC-2024-001/publicComments"

Path Parameters

applicationId

string

required

Unique application identifier

Request Body

The request body should contain comment data and metadata. See the OpenAPI specification for detailed schema.

Response

data

null

Empty success response

status

object

Status object with code 200 and message “OK”

Document Types

Supported document type values for filtering:

accessRoadsRightsOfWayDetails
advertsDrawings
affordableHousingStatement
arboriculturistReport
designAndAccessStatement
ecologyReport
elevations.existing
elevations.proposed
energyStatement
floorPlan.existing
floorPlan.proposed
floodRiskAssessment
heritageStatement
landscapeStrategy
locationPlan
noiseAssessment
planningStatement
photographs.existing
photographs.proposed
roofPlan.existing
roofPlan.proposed
sections.existing
sections.proposed
sitePlan.existing
sitePlan.proposed
transportAssessment
travelPlan
treeSurvey
visualisations

For a complete list of 100+ document types, refer to the OpenAPI specification.

Rate Limiting

Rate limiting policies are determined by individual API implementations. Consult your specific API provider for rate limit details.

Error Handling

All endpoints return errors in the standard response format:

{
  "data": null,
  "status": {
    "code": 400,
    "message": "Bad Request",
    "detail": "Invalid parameter: sortBy"
  }
}

See Response Structure for details on error responses.

Next Steps

Response Structure

Learn about response formats

Filtering

Advanced filtering techniques

API Implementation

Type Reference

​Public Endpoints

​Get Published Applications

​Query Parameters

​Response

​Get Published Application

​Path Parameters

​Response

​Get Published Documents

​Path Parameters

​Query Parameters

​Response

​Get Published Document

​Path Parameters

​Response

​Get Published Public Comments

​Path Parameters

​Query Parameters

​Response

​Get Published Public Comment

​Path Parameters

​Response

​Get Published Specialist Comments

​Path Parameters

​Query Parameters

​Response

​Get Published Specialist

​Path Parameters

​Query Parameters

​Response

​Private Endpoints

​Get Applications

​Send Public Comment

​Path Parameters

​Request Body

​Response

​Document Types

​Rate Limiting

​Error Handling

​Next Steps

Response Structure

Filtering

Build docs developers (and LLMs) love

Public Endpoints

Get Published Applications

Query Parameters

Response

Get Published Application

Path Parameters

Response

Get Published Documents

Path Parameters

Query Parameters

Response

Get Published Document

Path Parameters

Response

Get Published Public Comments

Path Parameters

Query Parameters

Response

Get Published Public Comment

Path Parameters

Response

Get Published Specialist Comments

Path Parameters

Query Parameters

Response

Get Published Specialist

Path Parameters

Query Parameters

Response

Private Endpoints

Get Applications

Send Public Comment

Path Parameters

Request Body

Response

Document Types

Rate Limiting

Error Handling

Next Steps