Skip to main content
GET
/
public
/
users
List Users
curl --request GET \
  --url https://api.carviz.com/prod/public/users/ \
  --header 'x-api-key: <api-key>'
{
  "items": [
    {
      "id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
      "name": "<string>",
      "is_active": true,
      "created_at": "2023-11-07T05:31:56Z",
      "organization_id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
      "created_by": "<string>",
      "entity_id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
      "role": "<string>",
      "photo": "<string>",
      "phone": "<string>",
      "position": "<string>",
      "email": "<string>",
      "last_activity": "2023-11-07T05:31:56Z"
    }
  ],
  "limit": 123,
  "offset": 123,
  "total": 123
}

Documentation Index

Fetch the complete documentation index at: https://docs.carviz.com/llms.txt

Use this file to discover all available pages before exploring further.

Authorizations

​
x-api-key
string
header
required

Query Parameters

​
limit
integer | null
default:100
​
offset
integer
default:0
​
name__ilike
string | null
​
created_at__gte
string<date-time> | null
​
created_at__lte
string<date-time> | null
​
organization_id
string<uuid> | null
​
entity_id
string<uuid> | null
​
dealership_id
string<uuid> | null
​
role
string | null
​
order_by
string | null

Response

Successful Response

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