Contractors.es icon

Contractors.es

Interact with Contractors.es API

Actions995

Job Visit Api → Get Api Contractors Job Visits

AI-generated

Summary

Retrieve a list of contractors' job visits from the Contractors.es API, supporting filters for trashed records, inclusion of related entities, pagination, and request customization.

Inputs

  • With Trashed — Boolean flag to include trashed (soft-deleted) job visits in the results.
  • Only Trashed — Boolean flag to return only trashed job visits.
  • Include — Array of related entities to include in the response, such as 'project', 'projectBidding', 'visitors', or 'visitType'.
  • Page — Page number for paginated results, defaulting to 1.
  • Limit — Number of records per page to return, defaulting to 20.
  • Request Options — Optional settings for request batching, SSL certificate handling, HTTP proxy, and request timeout.

Output shape

a paginated list of job visit records from the Contractors.es API, optionally enriched with related entities per the 'include' parameter.

Supports pagination via 'page' and 'limit' query parameters. Filtering via 'with_trashed' and 'only_trashed' controls inclusion of soft-deleted records. Related entities can be included in comma-separated form. Requests honor settings for batching, SSL handling, proxy, and timeout. Errors and edge cases depend on API response and network conditions.

Examples

Example 1: Fetch first page of job visits including associated project and visitor details, excluding trashed records.

with_trashed=false, only_trashed=false, include=['project','visitors'], page=1, limit=20

Links

Discussion