Skip to main content
GET
/
public
/
dealerships
List Dealerships
curl --request GET \
  --url https://api.carviz.com/prod/public/dealerships/ \
  --header 'x-api-key: <api-key>'
{
  "items": [
    {
      "id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
      "name": "<string>",
      "created_at": "2023-11-07T05:31:56Z",
      "updated_at": "2023-11-07T05:31:56Z",
      "organization_id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
      "entity_id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
      "address": {},
      "logo": "<string>",
      "illustration_img": "<string>",
      "more_info": "<string>",
      "position": 123,
      "siret": "<string>",
      "headquarter": true,
      "brands": [
        "<string>"
      ]
    }
  ],
  "offset": 123,
  "total": 123,
  "limit": 123
}

Authorizations

x-api-key
string
header
required

Query Parameters

limit
integer | null
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
entity_id
string<uuid> | null
name__ilike
string | null
order_by
string | null

Response

Successful Response

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