Skip to main content

List fleet inspections

GET 

/fleets

Returns only fleet inspections owned by the authenticated insurer. The API allows 60 requests per minute for each authenticated account.

Request​

Query Parameters

    search string

    Search the fleet name. Ignored when filter is all.

    per_page integer

    Possible values: >= 1

    Default value: 10

    Number of fleets per page. Ignored when filter is all.

    filter string

    Possible values: [all]

    Set to all to return an unpaginated minimal collection.

Responses​

Fleet inspections returned successfully. Paginated requests also include links and meta.

Schema
    data object[]required
  • Array [
  • uid string

    Fleet ULID used in fleet API URLs.

    id string

    Alias of uid.

    inspection_type string

    Possible values: [personal, corporate]

    name string
    company_name string
    company_phone_no string
    company_email email
    status string
    payment_status string
    policy_start_date datenullable
    policy_end_date datenullable
    meta object[]

    Uploaded fleet documents. Returned by the get operation.

  • Array [
  • type string
    url uri
    file string
  • ]
  • insurer object

    Returned by the get operation.

    id integer
    code string
    has_policies integer

    Number of policies attached to the fleet.

    vehicles_count integer
    created_at date-time
    inspection_link uri
  • ]
  • links objectnullable
    first string
    last string
    prev stringnullable
    next stringnullable
    meta objectnullable
    current_page integer
    from integernullable
    last_page integer
    per_page integer
    to integernullable
    total integer
Loading...