Permit, license, inspection, contractor, appeals, case and violation data from the Department of Licenses & Inspections.

Examples of filter use

  • To get all Locations for Zip Code 19107 ordered by Street Name and Street Number:
    • "/locations?$filter=substringof('19107',zip)%20eq%20true&orderby=street_name,street_number"
  • To get all Cases with a Resolution Code "CLOSED" for a Location Id 525027:
    • "/locations(525027)/cases?$filter=resolution%20eq%20'CLOSED'"
  • To get all Cases with a Resolution "CLOSED" ordered by Added Datetime descending:
    • /cases?$filter=resolution%20eq%20'CLOSED'&orderby=added_datetime%20desc

NOTE ABOUT APPEAL BOARDS

Three separate boards hear and review appeals for citations, permit denials and revocations, and building variances issued by the Department of Licenses and Inspections and other City agencies. The Zoning Board of Adjustment (ZBA) hears and decides appeals in zoning matters, considers special exceptions, and grants variances. The L&I Review Board (LIRB) hears appeals to property violations issued by the Department of Licenses and Inspections and, in some instances, other city agencies, such as the Water Department and the Art and Historical Commissions. The Board of Building Standards (BBS) is an advisory board that reviews appeals related to building safety and the application of Philadelphia’s Building Code.

Each Appeal has a unique Appeal Key that can be used to get further information about that appeal. Such information about each appeal includes an appeal number, application type, grounds (reason) for the appeal, the primary applicant applying for the appeal, and the associated Case or Permit. Further information includes the date of a previous or upcoming hearing and the decisions made at previous hearings. If an Appeal is denied, an applicant may progress the Appeal to Court. If the Appeal progresses to Court, information is available for the resulting Court Case once a decision has been reached, including the action date, case number, court action, court result, and any provisos.

This API conforms to the OData protocol specification. More information on the OData specification, including documentation and pre-built client libraries can be found on the OData web site.

API Keys

An API key is required for making requests to this API.

Registered users may request API keys and receive them instantly. Log in or register to request and manage API keys.

Press Use to select a key to use for test requests:

Paths

/locations

get /locations

A location is typically a street address for a parcel of land or a sub-unit of a parcel. Each location is associated with a city, state, ZIP code, and geographic X-Y coordinates, as well as geographic divisions such as City Council District, Census Tract, Census Block Group, and Political Ward.

Parameters
Name Located in Description Required Schema
$filter query

Filter results by specific fields. (No filter by default)

string
$expand query

Enter "locations" here to see all location data related to the returned licenses.

string
$format query

Format of returned data. Can be either XML or JSON (XML by default).

string
$callback query

Enables callbacks for asynchronous web service calls. (No callbacks by default)

string
Responses
Code Description Schema
200

An array of Locations

[array]
Model: Location
Name Required Schema
location_id integer

Address Key

street_number string

House Number

postfix string

House Number Postfix

street_direction string

Street Direction

street_name string

Street Name

street_suffix string

Street Suffix

city string

City

state string

State

zip string

ZIP Code

x number

Longitude

y number

Latitude

census_tract string

Census Tract

council_district string

Council District

condo_unit string

Condo Unit

unit_number string

Unit Number

census_block string

Census Block

ward string

Political Ward

default

unexpected error

Model: errorModel
Name Required Schema
code integer (int32)
message string

/locations({location_id})

get /locations({location_id})

A location is typically a street address for a parcel of land or a sub-unit of a parcel. Each location is associated with a city, state, ZIP code, and geographic X-Y coordinates, as well as geographic divisions such as City Council District, Census Tract, Census Block Group, and Political Ward.

Parameters
Name Located in Description Required Schema
location_id path

Location ID to retrieve data for.

integer (int32)
$filter query

Filter results by specific fields. (No filter by default)

string
$expand query

Enter "locations" here to see all location data related to the returned licenses.

string
$format query

Format of returned data. Can be either XML or JSON (XML by default).

string
$callback query

Enables callbacks for asynchronous web service calls. (No callbacks by default)

string
Responses
Code Description Schema
200

An array of Locations

[array]
Model: Location
Name Required Schema
location_id integer

Address Key

street_number string

House Number

postfix string

House Number Postfix

street_direction string

Street Direction

street_name string

Street Name

street_suffix string

Street Suffix

city string

City

state string

State

zip string

ZIP Code

x number

Longitude

y number

Latitude

census_tract string

Census Tract

council_district string

Council District

condo_unit string

Condo Unit

unit_number string

Unit Number

census_block string

Census Block

ward string

Political Ward

default

unexpected error

Model: errorModel
Name Required Schema
code integer (int32)
message string

/permits

get /permits

A permit grants legal permission to commence work on physical changes or zoning changes to a lot or structure. These include but are not limited to new constructions, alterations, demolitions, occupancy changes, and installations of and modifications to electrical, mechanical, and plumbing systems.

Each permit has a unique Permit Number. The Application Type Description (and the abbreviated Application Type) indicates the general nature of the permit application (for example, whether the permit is for new construction or mechanical work).

The Permit Code Description is more specific and describes in detail the objectives of the permitted work. For example, in the case of mechanical work a Code Description may specify the type and number of appliances to be installed (MEC-EQUIPMENT/APPLIANCE INSTAL). There is then a Description of Work for each specific permit to summarize the intent of the work. The Status and Last Modified Date indicate the current standing of the project. Contact information is provided for the primary contact and/or the contractor working on the project.

Parameters
Name Located in Description Required Schema
$filter query

Filter permit results by specific fields. (No filter by default)

string
$expand query

Enter "locations" here to see all location data related to the returned licenses.

string
$format query

Format of returned data. Can be either XML or JSON (XML by default).

string
$callback query

Enables callbacks for asynchronous web service calls. (No callbacks by default)

string
Responses
Code Description Schema
200

An array of Permits

[array]
Model: Permit
Name Required Schema
permit_number string

Permit Number

issued_datetime string

Issue Date Time

updated_datetime string

Last Updated Date Time

work_description string

Description of Permitted Work

permit_type_code string

Permit Type Code

permit_type_name string

Permit Type Name

application_type string

Application Type

application_description string

Application Description

status string

Permit Status

pri_contact_type string

Primary Contact Type

pri_contact_company_name string

Primary Contact Company Name

pri_contact_last_name string

Primary Contact Last Name

pri_contact_first_name string

Primary Contact First Name

pri_contact_address1 string

Primary Contact Address Line 1

pri_contact_address2 string

Primary Contact Address Line 2

pri_contact_city string

Primary Contact City

pri_contact_state string

Primary Contact State

pri_contact_zip string

Primary Contact ZIP Code

contractor_name string

Primary Contractor Name

contractor_address1 string

Primary Contractor Address Line 1

contractor_address2 string

Primary Contractor Address Line 2

contractor_city string

Primary Contractor City

contractor_state string

Primary Contractor State

contractor_zip string

Primary Contractor ZIP Code

location_id integer

Address Key

default

unexpected error

Model: errorModel
Name Required Schema
code integer (int32)
message string

/permits('{permit_number}')

get /permits('{permit_number}')

A permit grants legal permission to commence work on physical changes or zoning changes to a lot or structure. These include but are not limited to new constructions, alterations, demolitions, occupancy changes, and installations of and modifications to electrical, mechanical, and plumbing systems.

Each permit has a unique Permit Number. The Application Type Description (and the abbreviated Application Type) indicates the general nature of the permit application (for example, whether the permit is for new construction or mechanical work).

The Permit Code Description is more specific and describes in detail the objectives of the permitted work. For example, in the case of mechanical work a Code Description may specify the type and number of appliances to be installed (MEC-EQUIPMENT/APPLIANCE INSTAL). There is then a Description of Work for each specific permit to summarize the intent of the work. The Status and Last Modified Date indicate the current standing of the project. Contact information is provided for the primary contact and/or the contractor working on the project.

Parameters
Name Located in Description Required Schema
permit_number path

Permit number to retrieve data for.

integer (int32)
$filter query

Filter permit results by specific fields. (No filter by default)

string
$expand query

Enter "locations" here to see all location data related to the returned licenses.

string
$format query

Format of returned data. Can be either XML or JSON (XML by default).

string
$callback query

Enables callbacks for asynchronous web service calls. (No callbacks by default)

string
Responses
Code Description Schema
200

An array of Permits

[array]
Model: Permit
Name Required Schema
permit_number string

Permit Number

issued_datetime string

Issue Date Time

updated_datetime string

Last Updated Date Time

work_description string

Description of Permitted Work

permit_type_code string

Permit Type Code

permit_type_name string

Permit Type Name

application_type string

Application Type

application_description string

Application Description

status string

Permit Status

pri_contact_type string

Primary Contact Type

pri_contact_company_name string

Primary Contact Company Name

pri_contact_last_name string

Primary Contact Last Name

pri_contact_first_name string

Primary Contact First Name

pri_contact_address1 string

Primary Contact Address Line 1

pri_contact_address2 string

Primary Contact Address Line 2

pri_contact_city string

Primary Contact City

pri_contact_state string

Primary Contact State

pri_contact_zip string

Primary Contact ZIP Code

contractor_name string

Primary Contractor Name

contractor_address1 string

Primary Contractor Address Line 1

contractor_address2 string

Primary Contractor Address Line 2

contractor_city string

Primary Contractor City

contractor_state string

Primary Contractor State

contractor_zip string

Primary Contractor ZIP Code

location_id integer

Address Key

default

unexpected error

Model: errorModel
Name Required Schema
code integer (int32)
message string

/permitcontractors

get /permitcontractors

The Permit Contractors entity contains a listing of all contractors associated with a particular permit application. For example, a Major Alteration permit may have one or more contractors associated with the application.

Parameters
Name Located in Description Required Schema
$filter query

Filter permit contractor results by specific fields. (No filter by default)

string
$expand query

Enter "locations" here to see all location data related to the returned licenses.

string
$format query

Format of returned data. Can be either XML or JSON (XML by default).

string
$callback query

Enables callbacks for asynchronous web service calls. (No callbacks by default)

string
Responses
Code Description Schema
200

An array of Permit Contractors

[array]
Model: Permit Contractors
Name Required Schema
permitcontractors.contact_name string

Contractor Name

permitcontractors.contact_address1 string

Contractor Address 1

permitcontractors.contact_address2 string

Contractor Address 2

permitcontractors.contact_city string

Contractor City

permitcontractors.contact_state string

Contractor State

permitcontractors.contact_zip string

Contractor Zip

permitcontractors.permit_number string

Permit Number

default

unexpected error

Model: errorModel
Name Required Schema
code integer (int32)
message string

/permitcontractors({permit_contractor_id})

get /permitcontractors({permit_contractor_id})

The Permit Contractors entity contains a listing of all contractors associated with a particular permit application. For example, a Major Alteration permit may have one or more contractors associated with the application.

Parameters
Name Located in Description Required Schema
permit_contractor_id path

Specific permit contractor ID to retrieve data for.

integer (int32)
$filter query

Filter permit contractor results by specific fields. (No filter by default)

string
$expand query

Enter "locations" here to see all location data related to the returned licenses.

string
$format query

Format of returned data. Can be either XML or JSON (XML by default).

string
$callback query

Enables callbacks for asynchronous web service calls. (No callbacks by default)

string
Responses
Code Description Schema
200

An array of Permit Contractors

[array]
Model: Permit Contractors
Name Required Schema
permitcontractors.contact_name string

Contractor Name

permitcontractors.contact_address1 string

Contractor Address 1

permitcontractors.contact_address2 string

Contractor Address 2

permitcontractors.contact_city string

Contractor City

permitcontractors.contact_state string

Contractor State

permitcontractors.contact_zip string

Contractor Zip

permitcontractors.permit_number string

Permit Number

default

unexpected error

Model: errorModel
Name Required Schema
code integer (int32)
message string

/licenses

get /licenses

Licenses are required for individuals and businesses to engage in select commercial activities. For example, vendors and restaurants require a license in order to sell goods and food and trades-people, such as plumbers and contractors, require a license in order to practice their trade. License Type and License Type Description indicates generally the type of license.

Each license has a unique License Number, an issue date (given when payment and all pre-requisites have been met), and a month and year of expiration. Status indicates whether the license is Active, Inactive, or Expired. Inactive Date indicates if and when a license became inactive before expiring. Primary contact information is provided for each license.

Parameters
Name Located in Description Required Schema
$filter query

Filter license results by specific fields. (No filter by default)

string
$expand query

Enter "locations" here to see all location data related to the returned licenses.

string
$format query

Format of returned data. Can be either XML or JSON (XML by default).

string
$callback query

Enables callbacks for asynchronous web service calls. (No callbacks by default)

string
Responses
Code Description Schema
200

An array of Licenses

[array]
Model: License
Name Required Schema
license_number string

License Number

license_type_code string

License Type Code

license_type_description string

License Type Description

issued_datetime string

Issue Date

expires_month string

Expiration Month

expires_year string

Expiration Year

inactive_datetime string

Inactive Date

status string

Status

pri_contact_type string

Primary Contact Type

pri_contact_company_name string

Primary Company Name

pri_contact_last_name string

Primary Contact Last Name

pri_contact_first_name string

Primary Contact First Name

pri_contact_address1 string

Primary Contact Address 1

pri_contact_address2 string

Primary Contact Address 2

pri_contact_city string

Primary Contact City

pri_contact_state string

Primary Contact State

pri_contact_zip string

Primary Contact Zip

location_id integer

Address Key

default

unexpected error

Model: errorModel
Name Required Schema
code integer (int32)
message string

/licenses/('{license_number}')

get /licenses/('{license_number}')

Licenses are required for individuals and businesses to engage in select commercial activities. For example, vendors and restaurants require a license in order to sell goods and food and trades-people, such as plumbers and contractors, require a license in order to practice their trade. License Type and License Type Description indicates generally the type of license.

Each license has a unique License Number, an issue date (given when payment and all prerequisites have been met), and a month and year of expiration. Status indicates whether the license is Active, Inactive, or Expired. Inactive Date indicates if and when a license became inactive before expiring. Primary contact information is provided for each license.

Parameters
Name Located in Description Required Schema
license_number path

License number to retrieve data for.

string
$filter query

Filter license results by specific fields. (No filter by default)

string
$expand query

Enter "locations" here to see all location data related to the returned licenses.

string
$format query

Format of returned data. Can be either XML or JSON (XML by default).

string
$callback query

Enables callbacks for asynchronous web service calls. (No callbacks by default)

string
Responses
Code Description Schema
200

An array of Licenses

[array]
Model: License
Name Required Schema
license_number string

License Number

license_type_code string

License Type Code

license_type_description string

License Type Description

issued_datetime string

Issue Date

expires_month string

Expiration Month

expires_year string

Expiration Year

inactive_datetime string

Inactive Date

status string

Status

pri_contact_type string

Primary Contact Type

pri_contact_company_name string

Primary Company Name

pri_contact_last_name string

Primary Contact Last Name

pri_contact_first_name string

Primary Contact First Name

pri_contact_address1 string

Primary Contact Address 1

pri_contact_address2 string

Primary Contact Address 2

pri_contact_city string

Primary Contact City

pri_contact_state string

Primary Contact State

pri_contact_zip string

Primary Contact Zip

location_id integer

Address Key

default

unexpected error

Model: errorModel
Name Required Schema
code integer (int32)
message string

/licensedcontractors

get /licensedcontractors

Building contractors and certain trades-people such as plumbers and electricians require licenses to practice their trade. Each Licensed Contractor is issued a unique Contractor License Number. Contact information is given for the individual being licensed.

Parameters
Name Located in Description Required Schema
$filter query

Filter licensed contractor results by specific fields. (No filter by default)

string
$expand query

Enter "locations" here to see all location data related to the returned licenses.

string
$format query

Format of returned data. Can be either XML or JSON (XML by default).

string
$callback query

Enables callbacks for asynchronous web service calls. (No callbacks by default)

string
Responses
Code Description Schema
200

An array of Licensed Contractors

[array]
Model: Licensed Contractor
Name Required Schema
licensed_contractor_id string

Contractor License Number

contact_name string

Contact Name

contact_address string

Contact Address

contact_city string

Contact City

contact_state string

Contact State

contact_zip string

Contact Zip

license_type_code string

License Code

default

unexpected error

Model: errorModel
Name Required Schema
code integer (int32)
message string

/licensedcontractors('{licensed_contractor_id}')

get /licensedcontractors('{licensed_contractor_id}')

Building contractors and certain trades-people such as plumbers and electricians require licenses to practice their trade. Each Licensed Contractor is issued a unique Contractor License Number. Contact information is given for the individual being licensed.

Parameters
Name Located in Description Required Schema
licensed_contractor_id path

Licensed contractor id to retrieve data for.

string
$filter query

Filter licensed contractor results by specific fields. (No filter by default)

string
$expand query

Enter "locations" here to see all location data related to the returned licenses.

string
$format query

Format of returned data. Can be either XML or JSON (XML by default).

string
$callback query

Enables callbacks for asynchronous web service calls. (No callbacks by default)

string
Responses
Code Description Schema
200

An array of Licensed Contractors

[array]
Model: Licensed Contractor
Name Required Schema
licensed_contractor_id string

Contractor License Number

contact_name string

Contact Name

contact_address string

Contact Address

contact_city string

Contact City

contact_state string

Contact State

contact_zip string

Contact Zip

license_type_code string

License Code

default

unexpected error

Model: errorModel
Name Required Schema
code integer (int32)
message string

/cases

get /cases

A case is a recorded instance, created when a property is inspected and cited for one or more violations of the Philadelphia Code. A property will be re-inspected after a certain time interval to see whether or not the violations on the case have been complied. Further actions may be taken by the department to resolve a case. These actions may include clean & seals, demolitions, or sending a case to court. Each case has a unique Case Number and cites a specific Location in violation.

Each Case is also assigned a Priority, indicating whether the property is Non Hazardous, Unsafe, or Imminently Dangerous. Relevant dates are associated with each Case to indicate when the case was created/added, when it was last updated, and, in the event of a resolution, when the case was resolved.

Parameters
Name Located in Description Required Schema
$filter query

Filter case results by specific fields. (No filter by default)

string
$expand query

Enter "locations" here to see all location data related to the returned licenses.

string
$format query

Format of returned data. Can be either XML or JSON (XML by default).

string
$callback query

Enables callbacks for asynchronous web service calls. (No callbacks by default)

string
Responses
Code Description Schema
200

An array of Cases

[array]
Model: Case
Name Required Schema
case_number string

Case Number

case_type string

Case Type

case_location string

Case Location

added_datetime string

Date Added

updated_datetime string

Date Last Modified

resolution string

Resolution

resolution_datetime string

Resolution Date

priority string

Priority

location_id integer

Address Key

default

unexpected error

Model: errorModel
Name Required Schema
code integer (int32)
message string

/cases('{case_number}')

get /cases('{case_number}')

A case is a recorded instance, created when a property is inspected and cited for one or more violations of the Philadelphia Code. A property will be re-inspected after a certain time interval to see whether or not the violations on the case have been complied. Further actions may be taken by the department to resolve a case. These actions may include clean & seals, demolitions, or sending a case to court. Each case has a unique Case Number and cites a specific Location in violation.

Each Case is also assigned a Priority, indicating whether the property is Non Hazardous, Unsafe, or Imminently Dangerous. Relevant dates are associated with each Case to indicate when the case was created/added, when it was last updated, and, in the event of a resolution, when the case was resolved.

Parameters
Name Located in Description Required Schema
case_number path

Case number to retrieve data for.

string
$filter query

Filter case results by specific fields. (No filter by default)

string
$expand query

Enter "locations" here to see all location data related to the returned licenses.

string
$format query

Format of returned data. Can be either XML or JSON (XML by default).

string
$callback query

Enables callbacks for asynchronous web service calls. (No callbacks by default)

string
Responses
Code Description Schema
200

An array of Cases

[array]
Model: Case
Name Required Schema
case_number string

Case Number

case_type string

Case Type

case_location string

Case Location

added_datetime string

Date Added

updated_datetime string

Date Last Modified

resolution string

Resolution

resolution_datetime string

Resolution Date

priority string

Priority

location_id integer

Address Key

default

unexpected error

Model: errorModel
Name Required Schema
code integer (int32)
message string

/violationdetails

get /violationdetails

Each case cites the sections of the Philadelphia Code of which a property is found in violation. These citations are known as Violations, which are given a unique Violation ID for each time the property is found to be in violation. The Violation Code corresponds to the section of the Philadelphia Code being violated and is further described in the synonymous Violation Description. Each Violation has a corresponding Case number and Location, initial date of violation, and Status from the most recent inspection of the Location.

Parameters
Name Located in Description Required Schema
$filter query

Filter violation results by specific fields. (No filter by default)

string
$expand query

Enter "locations" here to see all location data related to the returned licenses.

string
$format query

Format of returned data. Can be either XML or JSON (XML by default).

string
$callback query

Enables callbacks for asynchronous web service calls. (No callbacks by default)

string
Responses
Code Description Schema
200

An array of Violations

[array]
Model: Violation Detail
Name Required Schema
violation_details_id integer

Violation ID

violation_code string

Violation Code

violation_description string

Violation Description

violation_datetime string

Violation Date

violation_status string

Violation Status

violation_location string

Violation Location

case_number string

Case Number

location_id integer

Address Key

default

unexpected error

Model: errorModel
Name Required Schema
code integer (int32)
message string

/violationdetails({violation_details_id})

get /violationdetails({violation_details_id})

Each case cites the sections of the Philadelphia Code of which a property is found in violation. These citations are known as Violations, which are given a unique Violation ID for each time the property is found to be in violation. The Violation Code corresponds to the section of the Philadelphia Code being violated and is further described in the synonymous Violation Description. Each Violation has a corresponding Case number and Location, initial date of violation, and Status from the most recent inspection of the Location.

Parameters
Name Located in Description Required Schema
violation_details_id path

Violation details id to retrieve data for.

integer (int32)
$filter query

Filter violation results by specific fields. (No filter by default)

string
$expand query

Enter "locations" here to see all location data related to the returned licenses.

string
$format query

Format of returned data. Can be either XML or JSON (XML by default).

string
$callback query

Enables callbacks for asynchronous web service calls. (No callbacks by default)

string
Responses
Code Description Schema
200

An array of Violations

[array]
Model: Violation Detail
Name Required Schema
violation_details_id integer

Violation ID

violation_code string

Violation Code

violation_description string

Violation Description

violation_datetime string

Violation Date

violation_status string

Violation Status

violation_location string

Violation Location

case_number string

Case Number

location_id integer

Address Key

default

unexpected error

Model: errorModel
Name Required Schema
code integer (int32)
message string

/zoningboardappeals

get /zoningboardappeals

Parameters
Name Located in Description Required Schema
$filter query

Filter zoning board appeal results by specific fields. (No filter by default)

string
$expand query

Enter "locations" here to see all location data related to the returned licenses.

string
$format query

Format of returned data. Can be either XML or JSON (XML by default).

string
$callback query

Enables callbacks for asynchronous web service calls. (No callbacks by default)

string
Responses
Code Description Schema
200

An array of Zoning Board Appeals

[array]
Model: Zoning Board Appeals
Name Required Schema
zoningboardappeals.appeal_id integer

Appeal Key

zoningboardappeals.appeal_number string

Appeal Number

zoningboardappeals.application_type string

Application Type

zoningboardappeals.capacity string

Capacity

zoningboardappeals.grounds string

Grounds

zoningboardappeals.primary_applicant string

Primary Applicant Name

zoningboardappeals.permit_number string

Permit Number

zoningboardappeals.location_id integer

Address Key

default

unexpected error

Model: errorModel
Name Required Schema
code integer (int32)
message string

/zoningboardappeals({appeal_id})

get /zoningboardappeals({appeal_id})

Parameters
Name Located in Description Required Schema
appeal_id path

Appeal id to retrieve data for.

integer (int32)
$filter query

Filter zoning board appeal results by specific fields. (No filter by default)

string
$expand query

Enter "locations" here to see all location data related to the returned licenses.

string
$format query

Format of returned data. Can be either XML or JSON (XML by default).

string
$callback query

Enables callbacks for asynchronous web service calls. (No callbacks by default)

string
Responses
Code Description Schema
200

An array of Zoning Board Appeals

[array]
Model: Zoning Board Appeals
Name Required Schema
zoningboardappeals.appeal_id integer

Appeal Key

zoningboardappeals.appeal_number string

Appeal Number

zoningboardappeals.application_type string

Application Type

zoningboardappeals.capacity string

Capacity

zoningboardappeals.grounds string

Grounds

zoningboardappeals.primary_applicant string

Primary Applicant Name

zoningboardappeals.permit_number string

Permit Number

zoningboardappeals.location_id integer

Address Key

default

unexpected error

Model: errorModel
Name Required Schema
code integer (int32)
message string

/lireviewboardappeals

get /lireviewboardappeals

Parameters
Name Located in Description Required Schema
$filter query

Filter L&I Review Board appeal results by specific fields. (No filter by default)

string
$expand query

Enter "locations" here to see all location data related to the returned licenses.

string
$format query

Format of returned data. Can be either XML or JSON (XML by default).

string
$callback query

Enables callbacks for asynchronous web service calls. (No callbacks by default)

string
Responses
Code Description Schema
200

An array of L&I Review Board Appeals

[array]
Model: L&I Review Board Appeals
Name Required Schema
lireviewboardappeals.appeal_id integer

Appeal Key

lireviewboardappeals.appeal_number string

Appeal Number

lireviewboardappeals.application_type string

Application Type

lireviewboardappeals.capacity string

Capacity

lireviewboardappeals.grounds string

Grounds

lireviewboardappeals.primary_applicant string

Primary Applicant Name

lireviewboardappeals.permit_number string

Permit Number

lireviewboardappeals.location_id integer

Address Key

default

unexpected error

Model: errorModel
Name Required Schema
code integer (int32)
message string

/lireviewboardappeals({appeal_id})

get /lireviewboardappeals({appeal_id})

Parameters
Name Located in Description Required Schema
appeal_id path

Appeal id to retrieve data for.

integer (int32)
$filter query

Filter L&I Review Board appeal results by specific fields. (No filter by default)

string
$expand query

Enter "locations" here to see all location data related to the returned licenses.

string
$format query

Format of returned data. Can be either XML or JSON (XML by default).

string
$callback query

Enables callbacks for asynchronous web service calls. (No callbacks by default)

string
Responses
Code Description Schema
200

An array of L&I Review Board Appeals

[array]
Model: L&I Review Board Appeals
Name Required Schema
lireviewboardappeals.appeal_id integer

Appeal Key

lireviewboardappeals.appeal_number string

Appeal Number

lireviewboardappeals.application_type string

Application Type

lireviewboardappeals.capacity string

Capacity

lireviewboardappeals.grounds string

Grounds

lireviewboardappeals.primary_applicant string

Primary Applicant Name

lireviewboardappeals.permit_number string

Permit Number

lireviewboardappeals.location_id integer

Address Key

default

unexpected error

Model: errorModel
Name Required Schema
code integer (int32)
message string

/buildingboardappeals

get /buildingboardappeals

Parameters
Name Located in Description Required Schema
$filter query

Filter Board of Building Standards appeal results by specific fields. (No filter by default)

string
$expand query

Enter "locations" here to see all location data related to the returned licenses.

string
$format query

Format of returned data. Can be either XML or JSON (XML by default).

string
$callback query

Enables callbacks for asynchronous web service calls. (No callbacks by default)

string
Responses
Code Description Schema
200

An array of Board of Building Standards Appeals

[array]
Model: Board of Building Standards Appeals
Name Required Schema
buildingboardappeals.appeal_id integer

Appeal Key

buildingboardappeals.appeal_number string

Appeal Number

buildingboardappeals.application_type string

Application Type

buildingboardappeals.capacity string

Capacity

buildingboardappeals.grounds string

Grounds

buildingboardappeals.primary_applicant string

Primary Applicant Name

buildingboardappeals.permit_number string

Permit Number

buildingboardappeals.location_id integer

Address

default

unexpected error

Model: errorModel
Name Required Schema
code integer (int32)
message string

/buildingboardappeals({appeal_id})

get /buildingboardappeals({appeal_id})

Parameters
Name Located in Description Required Schema
appeal_id path

Appeal id to retrieve data for.

integer (int32)
$filter query

Filter Board of Building Standards appeal results by specific fields. (No filter by default)

string
$expand query

Enter "locations" here to see all location data related to the returned licenses.

string
$format query

Format of returned data. Can be either XML or JSON (XML by default).

string
$callback query

Enables callbacks for asynchronous web service calls. (No callbacks by default)

string
Responses
Code Description Schema
200

An array of Board of Building Standards Appeals

[array]
Model: Board of Building Standards Appeals
Name Required Schema
buildingboardappeals.appeal_id integer

Appeal Key

buildingboardappeals.appeal_number string

Appeal Number

buildingboardappeals.application_type string

Application Type

buildingboardappeals.capacity string

Capacity

buildingboardappeals.grounds string

Grounds

buildingboardappeals.primary_applicant string

Primary Applicant Name

buildingboardappeals.permit_number string

Permit Number

buildingboardappeals.location_id integer

Address

default

unexpected error

Model: errorModel
Name Required Schema
code integer (int32)
message string

/appealhearings

get /appealhearings

Parameters
Name Located in Description Required Schema
$filter query

Filter Appeal Hearing results by specific fields. (No filter by default)

string
$expand query

Enter "locations" here to see all location data related to the returned licenses.

string
$format query

Format of returned data. Can be either XML or JSON (XML by default).

string
$callback query

Enables callbacks for asynchronous web service calls. (No callbacks by default)

string
Responses
Code Description Schema
200

An array of Appeal Hearings

[array]
Model: Appeal Hearings
Name Required Schema
appeal_hearing_id integer

Auto-generated Primary Key

appeal_id integer

Appeal Key

application_type string

Application Type

capacity string

Primary Applicant Capacity

grounds string

Appeal Grounds

primary_applicant string

Primary Applicant

scheduled_datetime string

Hearing Date Time

location_id integer

Address Key

default

unexpected error

Model: errorModel
Name Required Schema
code integer (int32)
message string

/appealhearings({appeal_hearing_id})

get /appealhearings({appeal_hearing_id})

Parameters
Name Located in Description Required Schema
appeal_hearing_id path

Appeal hearing id to retrieve data for.

integer (int32)
$filter query

Filter Appeal Hearing results by specific fields. (No filter by default)

string
$expand query

Enter "locations" here to see all location data related to the returned licenses.

string
$format query

Format of returned data. Can be either XML or JSON (XML by default).

string
$callback query

Enables callbacks for asynchronous web service calls. (No callbacks by default)

string
Responses
Code Description Schema
200

An array of Appeal Hearings

[array]
Model: Appeal Hearings
Name Required Schema
appeal_hearing_id integer

Auto-generated Primary Key

appeal_id integer

Appeal Key

application_type string

Application Type

capacity string

Primary Applicant Capacity

grounds string

Appeal Grounds

primary_applicant string

Primary Applicant

scheduled_datetime string

Hearing Date Time

location_id integer

Address Key

default

unexpected error

Model: errorModel
Name Required Schema
code integer (int32)
message string

/hearingdates

get /hearingdates

Parameters
Name Located in Description Required Schema
$filter query

Filter Hearing Date results by specific fields. (No filter by default)

string
$expand query

Enter "locations" here to see all location data related to the returned licenses.

string
$format query

Format of returned data. Can be either XML or JSON (XML by default).

string
$callback query

Enables callbacks for asynchronous web service calls. (No callbacks by default)

string
Responses
Code Description Schema
200

An array of Hearing Dates

[array]
Model: Hearing Dates
Name Required Schema
hearing_id string

Entity Primary Key

scheduled_datetime string

Appeal Scheduled Date

board_type string

Appeal Type

default

unexpected error

Model: errorModel
Name Required Schema
code integer (int32)
message string

/hearingdates('{hearing_id}')

get /hearingdates('{hearing_id}')

Parameters
Name Located in Description Required Schema
hearing_id path

Hearing id to retrieve data for.

string
$filter query

Filter Hearing Date results by specific fields. (No filter by default)

string
$expand query

Enter "locations" here to see all location data related to the returned licenses.

string
$format query

Format of returned data. Can be either XML or JSON (XML by default).

string
$callback query

Enables callbacks for asynchronous web service calls. (No callbacks by default)

string
Responses
Code Description Schema
200

An array of Hearing Dates

[array]
Model: Hearing Dates
Name Required Schema
hearing_id string

Entity Primary Key

scheduled_datetime string

Appeal Scheduled Date

board_type string

Appeal Type

default

unexpected error

Model: errorModel
Name Required Schema
code integer (int32)
message string

/locationhistories

get /locationhistories

The Location Histories entity describes a history of various activities at a particular address. Activities may include Zoning Board Hearing Results, Code Enforcement Violations written, Permits Issued or Licenses Issued. For example, an address may have several open permits and a recently issued Business License in its history.

Parameters
Name Located in Description Required Schema
$filter query

Filter Location History results by specific fields. (No filter by default)

string
$expand query

Enter "locations" here to see all location data related to the returned licenses.

string
$format query

Format of returned data. Can be either XML or JSON (XML by default).

string
$callback query

Enables callbacks for asynchronous web service calls. (No callbacks by default)

string
Responses
Code Description Schema
200

An array of Location Histories

[array]
Model: Location History
Name Required Schema
locationhistories.entity_id string

Related Entity ID

locationhistories.entity_name string

Hardcoded Entity Name

locationhistories.entity_type string

Hardcoded Entity Type

locationhistories.entity_category string

Hardcoded Entity Category

locationhistories.location_id integer

Address Key

default

unexpected error

Model: errorModel
Name Required Schema
code integer (int32)
message string

/locationhistories({location_history_id})

get /locationhistories({location_history_id})

The Location Histories entity describes a history of various activities at a particular address. Activities may include Zoning Board Hearing Results, Code Enforcement Violations written, Permits Issued or Licenses Issued. For example, an address may have several open permits and a recently issued Business License in its history.

Parameters
Name Located in Description Required Schema
location_history_id path

Location history id to retrieve data for.

integer (int32)
$filter query

Filter Location History results by specific fields. (No filter by default)

string
$expand query

Enter "locations" here to see all location data related to the returned licenses.

string
$format query

Format of returned data. Can be either XML or JSON (XML by default).

string
$callback query

Enables callbacks for asynchronous web service calls. (No callbacks by default)

string
Responses
Code Description Schema
200

An array of Location Histories

[array]
Model: Location History
Name Required Schema
locationhistories.entity_id string

Related Entity ID

locationhistories.entity_name string

Hardcoded Entity Name

locationhistories.entity_type string

Hardcoded Entity Type

locationhistories.entity_category string

Hardcoded Entity Category

locationhistories.location_id integer

Address Key

default

unexpected error

Model: errorModel
Name Required Schema
code integer (int32)
message string

Models

Model: Location
Name Required Schema
location_id integer

Address Key

street_number string

House Number

postfix string

House Number Postfix

street_direction string

Street Direction

street_name string

Street Name

street_suffix string

Street Suffix

city string

City

state string

State

zip string

ZIP Code

x number

Longitude

y number

Latitude

census_tract string

Census Tract

council_district string

Council District

condo_unit string

Condo Unit

unit_number string

Unit Number

census_block string

Census Block

ward string

Political Ward

Model: Permit
Name Required Schema
permit_number string

Permit Number

issued_datetime string

Issue Date Time

updated_datetime string

Last Updated Date Time

work_description string

Description of Permitted Work

permit_type_code string

Permit Type Code

permit_type_name string

Permit Type Name

application_type string

Application Type

application_description string

Application Description

status string

Permit Status

pri_contact_type string

Primary Contact Type

pri_contact_company_name string

Primary Contact Company Name

pri_contact_last_name string

Primary Contact Last Name

pri_contact_first_name string

Primary Contact First Name

pri_contact_address1 string

Primary Contact Address Line 1

pri_contact_address2 string

Primary Contact Address Line 2

pri_contact_city string

Primary Contact City

pri_contact_state string

Primary Contact State

pri_contact_zip string

Primary Contact ZIP Code

contractor_name string

Primary Contractor Name

contractor_address1 string

Primary Contractor Address Line 1

contractor_address2 string

Primary Contractor Address Line 2

contractor_city string

Primary Contractor City

contractor_state string

Primary Contractor State

contractor_zip string

Primary Contractor ZIP Code

location_id integer

Address Key

Model: Permit Contractors
Name Required Schema
permitcontractors.contact_name string

Contractor Name

permitcontractors.contact_address1 string

Contractor Address 1

permitcontractors.contact_address2 string

Contractor Address 2

permitcontractors.contact_city string

Contractor City

permitcontractors.contact_state string

Contractor State

permitcontractors.contact_zip string

Contractor Zip

permitcontractors.permit_number string

Permit Number

Model: License
Name Required Schema
license_number string

License Number

license_type_code string

License Type Code

license_type_description string

License Type Description

issued_datetime string

Issue Date

expires_month string

Expiration Month

expires_year string

Expiration Year

inactive_datetime string

Inactive Date

status string

Status

pri_contact_type string

Primary Contact Type

pri_contact_company_name string

Primary Company Name

pri_contact_last_name string

Primary Contact Last Name

pri_contact_first_name string

Primary Contact First Name

pri_contact_address1 string

Primary Contact Address 1

pri_contact_address2 string

Primary Contact Address 2

pri_contact_city string

Primary Contact City

pri_contact_state string

Primary Contact State

pri_contact_zip string

Primary Contact Zip

location_id integer

Address Key

Model: Licensed Contractor
Name Required Schema
licensed_contractor_id string

Contractor License Number

contact_name string

Contact Name

contact_address string

Contact Address

contact_city string

Contact City

contact_state string

Contact State

contact_zip string

Contact Zip

license_type_code string

License Code

Model: Case
Name Required Schema
case_number string

Case Number

case_type string

Case Type

case_location string

Case Location

added_datetime string

Date Added

updated_datetime string

Date Last Modified

resolution string

Resolution

resolution_datetime string

Resolution Date

priority string

Priority

location_id integer

Address Key

Model: Violation Detail
Name Required Schema
violation_details_id integer

Violation ID

violation_code string

Violation Code

violation_description string

Violation Description

violation_datetime string

Violation Date

violation_status string

Violation Status

violation_location string

Violation Location

case_number string

Case Number

location_id integer

Address Key

Model: Zoning Board Appeals
Name Required Schema
zoningboardappeals.appeal_id integer

Appeal Key

zoningboardappeals.appeal_number string

Appeal Number

zoningboardappeals.application_type string

Application Type

zoningboardappeals.capacity string

Capacity

zoningboardappeals.grounds string

Grounds

zoningboardappeals.primary_applicant string

Primary Applicant Name

zoningboardappeals.permit_number string

Permit Number

zoningboardappeals.location_id integer

Address Key

Model: Zoning Board Appeal Hearing Decisions
Name Required Schema
zbahearingdecisions.hearing_decision_id integer

Auto-generated Primary Key

zbahearingdecisions.decision string

Decision

zbahearingdecisions.decision_datetime string

Decision Date

zbahearingdecisions.proviso string

Proviso

zbahearingdecisions.appeal_id integer

Appeal Key

Model: Zoning Board Court Details
Name Required Schema
zbacourtdetails.court_details_id integer

Auto-generated Primary Key

zbacourtdetails.court string

Court

zbacourtdetails.court_action_datetime string

Court Action Date

zbacourtdetails.court_case_number string

Court Case Number

zbacourtdetails.court_action string

Court Action

zbacourtdetails.court_result string

Court Result

zbacourtdetails.court_proviso string

Court Proviso

zbacourtdetails.appeal_id integer

Appeal Key

Model: Zoning Board Appeal Types
Name Required Schema
zbaappealtypes.appeal_type string

Appeal Type

zbaappealtypes.appeal_id integer

Appeal Key

Model: Zoning Board Appeal Activities
Name Required Schema
zbaappealactivities.appeal_activity_id integer

Auto-generated Primary Key

zbaappealactivities.board_type string

Board Type

zbaappealactivities.hearing_datetime string

Hearing Date

zbaappealactivities.review_description string

Review Description

zbaappealactivities.review_scheduled_datetime string

Review Scheduled Date

zbaappealactivities.appeal_id integer

Appeal Key

Model: L&I Review Board Appeals
Name Required Schema
lireviewboardappeals.appeal_id integer

Appeal Key

lireviewboardappeals.appeal_number string

Appeal Number

lireviewboardappeals.application_type string

Application Type

lireviewboardappeals.capacity string

Capacity

lireviewboardappeals.grounds string

Grounds

lireviewboardappeals.primary_applicant string

Primary Applicant Name

lireviewboardappeals.permit_number string

Permit Number

lireviewboardappeals.location_id integer

Address Key

Model: L&I Review Board Hearing Decisions
Name Required Schema
lirbhearingdecisions.hearing_decision_id integer

Auto-generated Primary Key

lirbhearingdecisions.decision string

Decision

lirbhearingdecisions.decision_datetime string

Decision Date

lirbhearingdecisions.proviso string

Proviso

lirbhearingdecisions.appeal_id integer

Appeal Key

Model: L&I Review Board Court Details
Name Required Schema
lirbcourtdetails.court_details_id integer

Auto-generated Primary Key

lirbcourtdetails.court string

Court

lirbcourtdetails.court_action_datetime string

Court Action Date

lirbcourtdetails.court_case_number string

Court Case Number

lirbcourtdetails.court_action string

Court Action

lirbcourtdetails.court_result string

Court Result

lirbcourtdetails.court_proviso string

Court Proviso

lirbcourtdetails.appeal_id integer

Appeal Key

Model: L&I Review Board Appeal Types
Name Required Schema
lirbappealtypes.appeal_type string

Appeal Type

lirbappealtypes.appeal_id integer

Appeal Key

Model: L&I Review Board Appeal Activities
Name Required Schema
lirbappealactivities.appeal_activity_id integer

Auto-generated Primary Key

lirbappealactivities.board_type string

Board Type

lirbappealactivities.hearing_datetime string

Hearing Date

lirbappealactivities.review_description string

Review Description

lirbappealactivities.review_scheduled_datetime string

Review Scheduled Date

lirbappealactivities.appeal_id integer

Appeal Key

Model: Board of Building Standards Appeals
Name Required Schema
buildingboardappeals.appeal_id integer

Appeal Key

buildingboardappeals.appeal_number string

Appeal Number

buildingboardappeals.application_type string

Application Type

buildingboardappeals.capacity string

Capacity

buildingboardappeals.grounds string

Grounds

buildingboardappeals.primary_applicant string

Primary Applicant Name

buildingboardappeals.permit_number string

Permit Number

buildingboardappeals.location_id integer

Address

Model: Board of Building Standards Hearing Decisions
Name Required Schema
bbshearingdecisions.hearing_decision_id integer

Auto-generated Primary Key

bbshearingdecisions.decision string

Decision

bbshearingdecisions.decision_datetime string

Decision Date

bbshearingdecisions.proviso string

Proviso

bbshearingdecisions.appeal_id integer

Appeal Key

Model: Board of Building Standards Court Details
Name Required Schema
bbscourtdetails.court_details_id integer

Auto-generated Primary Key

bbscourtdetails.court string

Court

bbscourtdetails.court_action_datetime string

Court Action Date

bbscourtdetails.court_case_number string

Court Case Number

bbscourtdetails.court_action string

Court Action

bbscourtdetails.court_result string

Court Result

bbscourtdetails.court_proviso string

Court Proviso

bbscourtdetails.appeal_id integer

Appeal Key

Model: Board of Building Standards Appeal Types
Name Required Schema
bbsappealtypes.appeak_type_id integer

Auto-generated Primary Key

bbsappealtypes.appeal_type string

Appeal Type

bbsappealtypes.appeal_id integer

Appeal Key

Model: Board of Building Standards Appeal Activities
Name Required Schema
bbsappealactivities.appeal_activity_id integer

Auto-generated Primary Key

bbsappealactivities.board_type string

Board Type

bbsappealactivities.hearing_datetime string

Hearing Date

bbsappealactivities.review_description string

Review Description

bbsappealactivities.review_scheduled_datetime string

Review Scheduled Date

bbsappealactivities.appeal_id integer

Appeal Key

Model: Hearing Dates
Name Required Schema
hearing_id string

Entity Primary Key

scheduled_datetime string

Appeal Scheduled Date

board_type string

Appeal Type

Model: Location History
Name Required Schema
locationhistories.entity_id string

Related Entity ID

locationhistories.entity_name string

Hardcoded Entity Name

locationhistories.entity_type string

Hardcoded Entity Type

locationhistories.entity_category string

Hardcoded Entity Category

locationhistories.location_id integer

Address Key

Model: Appeal Hearings
Name Required Schema
appeal_hearing_id integer

Auto-generated Primary Key

appeal_id integer

Appeal Key

application_type string

Application Type

capacity string

Primary Applicant Capacity

grounds string

Appeal Grounds

primary_applicant string

Primary Applicant

scheduled_datetime string

Hearing Date Time

location_id integer

Address Key

Model: errorModel
Name Required Schema
code integer (int32)
message string