SHshovels
Contractors
Contractors

Get Permits By Contractor Id

Changed on

Retrieves all permits associated with a single contractor.

get/contractors/{id}/permits

Request

  • Base URL
    https://api.shovels.ai/v2
  • Auth
    API key in header X-API-Key

Path parameters

idstring required

Filter by the specified contractor ID.

Query parameters

cursorstring nullable

Cursor for pagination

sizeinteger
include_countboolean

When true and on the first page (no cursor), include total_count in the response. The count is exact up to 10,000; above that, relation is 'gte'.

Response

A list of permits associated with the contractor and grouped by address

sizeinteger required

The number of items returned in the response.

next_cursorstring nullable required

The cursor for retrieving the next page of results.

Changes

  • 64df4c8074f5Revision changes
    • breaking

      for the query request parameter size, default value was changed from 50 to 10

  • 685b8866c451Revision changes
    • info

      added the optional property // to the response with the status

    • info

      added the optional property // to the response with the status

    • info

      added the optional property // to the response with the status