Skip to main content
A successful API request returns a 200 status code along with the requested data.

​
Success Response

When your request succeeds, you’ll receive:
  • HTTP status code: 200 OK
  • Response body with your requested data
total_count is returned only when you pass include_count=true on the first page (no cursor). relation is eq for an exact count, or gte when the true count exceeds the 10,000 cap.

​
Error Responses

If there are issues, you’ll receive an error code indicating the problem:

​
Empty Results vs Errors

A 200 response with an empty items array is not an error. It means:
  • The address or geo_id is valid
  • No permits match your query criteria
This commonly happens when:
  • The address has no permits in our system
  • Your date filters exclude all results
  • The geo_id format is valid but doesn’t match any records

​
Troubleshooting

  1. Check your API key - Ensure it’s correctly included in the header
  2. Verify required parameters - Most endpoints require a geo_id
  3. Review date formats - Use YYYY-MM-DD format
  4. Check the response body - Error messages describe what’s wrong