Skip to main content
GET
/
public
/
reports
List Reports
curl --request GET \
  --url https://api.carviz.com/prod/public/reports/ \
  --header 'x-api-key: <api-key>'
{
  "items": [
    {
      "token": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
      "created_at": "2023-11-07T05:31:56Z",
      "updated_at": "2023-11-07T05:31:56Z",
      "data": {
        "vehicle": {
          "vin": "<string>",
          "license_number": "<string>"
        }
      },
      "organization_id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
      "profile": {
        "id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
        "name": "<string>",
        "email": "<string>",
        "phone": "<string>"
      },
      "dealership_id": "3c90c3cc-0d44-4b50-8888-8dd25736052a"
    }
  ],
  "offset": 123,
  "total": 123,
  "limit": 123
}

Authorizations

​
x-api-key
string
header
required

Query Parameters

​
limit
integer | null
default:100
​
offset
integer
default:0
​
created_at__gte
string<date-time> | null
​
created_at__lte
string<date-time> | null
​
updated_at__gte
string<date-time> | null
​
updated_at__lte
string<date-time> | null
​
organization_id
string<uuid> | null
​
dealership_id
string<uuid> | null
​
profile_id
string<uuid> | null
​
contact_id
string<uuid> | null
​
counter_id
string<uuid> | null
​
vin
string | null
​
license_number
string | null
​
valid
boolean | null
default:true
​
type
enum<string> | null
Available options:
inspection,
counter_inspection,
after_sale,
marketing,
rental,
insurance,
remote
​
data__contains
unknown
​
state__contains
unknown
​
order_by
string | null

Response

Successful Response

​
items
ReportsCompactRead · object[]
required
​
offset
integer
required
​
total
integer
required
​
limit
integer | null