Rental Cars

List rental cars

GET/v1/teams/{teamId}/rental-cars

Lists rental car records for a team.

Required scopes: rental_car:read

Parameters

`path.teamId`required	`string:uuid` Team identifier.
`query.date`	`string:date` Optional local date filter in YYYY-MM-DD format. Returns rentals whose pickup/drop-off date range overlaps this date.
`query.limit`	`integer` Maximum number of records to return. Defaults to 50 and is capped at 200.
`query.cursor`	`string` Cursor returned by page.nextCursor from the previous list response.

Response 200

`data`	`object[]`
`data[].companyName`	`string` Rental car company name.
`data[].label`	`string` Optional short display label.
`data[].confirmationNumber`	`string` Rental booking confirmation number.
`data[].status`	`"confirmed" \| "unconfirmed"` Rental confirmation state.
`data[].priority`	`"normal" \| "high"` Rental display priority.
`data[].pickupDate`	`string` Local rental date in YYYY-MM-DD format at the corresponding rental location.
`data[].pickupTime`	`string` Local rental time in HH:mm 24-hour format at the corresponding rental location.
`data[].pickupLocation`	`object` Rental pickup or drop-off location, including its required timezone.
`data[].pickupLocation.label`	`string` Human-readable place label.
`data[].pickupLocation.address`	`string` Street address or venue address.
`data[].pickupLocation.placeId`	`string` Google Places ID when available.
`data[].pickupLocation.latitude`	`number` Latitude in decimal degrees.
`data[].pickupLocation.longitude`	`number` Longitude in decimal degrees.
`data[].pickupLocation.timezone`	`object` IANA timezone used to interpret and display the rental pickup or drop-off time.
`data[].dropoffDate`	`string` Local rental date in YYYY-MM-DD format at the corresponding rental location.
`data[].dropoffTime`	`string` Local rental time in HH:mm 24-hour format at the corresponding rental location.
`data[].dropoffLocation`	`object` Rental pickup or drop-off location, including its required timezone.
`data[].dropoffLocation.label`	`string` Human-readable place label.
`data[].dropoffLocation.address`	`string` Street address or venue address.
`data[].dropoffLocation.placeId`	`string` Google Places ID when available.
`data[].dropoffLocation.latitude`	`number` Latitude in decimal degrees.
`data[].dropoffLocation.longitude`	`number` Longitude in decimal degrees.
`data[].dropoffLocation.timezone`	`object` IANA timezone used to interpret and display the rental pickup or drop-off time.
`data[].primaryDriver`	`object` Primary renter or driver.
`data[].primaryDriver.name`	`string` Contact person's name.
`data[].primaryDriver.title`	`string` Contact person's role or job title.
`data[].primaryDriver.phone`	`string` Contact phone number.
`data[].primaryDriver.email`	`string:email` Contact email address.
`data[].primaryDriver.notes`	`string` Short notes about this contact.
`data[].vehicleClass`	`string` Reserved vehicle class.
`data[].vehicleDescription`	`string` Assigned vehicle or other vehicle details.
`data[].contacts`	`object[]` Rental company contacts.
`data[].contacts[].name`	`string` Contact person's name.
`data[].contacts[].title`	`string` Contact person's role or job title.
`data[].contacts[].phone`	`string` Contact phone number.
`data[].contacts[].email`	`string:email` Contact email address.
`data[].contacts[].notes`	`string` Short notes about this contact.
`data[].notes`	`string` General rental notes.
`data[].sourceMetadata`	`object` Integration or import metadata retained with the rental.
`data[].visibility`	`object` Optional rental visibility rules.
`data[].visibility.groupIds`	`string:uuid[]`
`data[].visibility.userIds`	`string:uuid[]`
`data[].pickupAt`	`string:date-time` Derived UTC pickup timestamp.
`data[].dropoffAt`	`string:date-time` Derived UTC drop-off timestamp.
`data[].id`	`string:uuid` Rental car identifier.
`data[].orgId`	`string:uuid` Team identifier.
`data[].isDeleted`	`boolean` Soft-delete flag.
`data[].version`	`integer` Current rental car aggregate version.
`data[].createdAt`	`string:date-time` ISO 8601 timestamp when the rental car was created.
`data[].createdBy`	`string` User identifier that created the rental car.
`data[].updatedAt`	`string:date-time` ISO 8601 timestamp of the latest update.
`data[].updatedBy`	`string` User identifier that last updated the rental car.
`data[].cursor`	`integer` Latest projected event-ledger cursor.
`page`	`object`
`page.limit`	`integer` Maximum number of records returned in this page.
`page.nextCursor`	`string \| null` Cursor to pass as the next request's cursor query parameter, or null when there are no more results.
`meta`	`object`
`meta.cursor`	`number \| null`

Response: List rental cars

{
  "data": [
    {
      "id": "00000000-0000-4000-8000-000000000923",
      "companyName": "Avis",
      "confirmationNumber": "CAR123",
      "status": "confirmed",
      "priority": "normal",
      "pickupDate": "2026-09-14",
      "pickupTime": "10:00",
      "pickupLocation": {
        "label": "Nashville International Airport",
        "address": "1 Terminal Dr, Nashville, TN",
        "timezone": "America/Chicago"
      },
      "dropoffDate": "2026-09-16",
      "dropoffTime": "09:00",
      "dropoffLocation": {
        "label": "Nashville International Airport",
        "address": "1 Terminal Dr, Nashville, TN",
        "timezone": "America/Chicago"
      },
      "contacts": [],
      "orgId": "00000000-0000-4000-8000-000000000100",
      "pickupAt": "2026-09-14T15:00:00.000Z",
      "dropoffAt": "2026-09-16T14:00:00.000Z",
      "isDeleted": false,
      "createdBy": "00000000-0000-4000-8000-000000000101",
      "createdAt": "2026-09-01T12:00:00.000Z",
      "version": 1,
      "cursor": 87235
    }
  ],
  "page": {
    "limit": 50,
    "nextCursor": null
  },
  "meta": {
    "cursor": 87234
  }
}

Create a rental car

POST/v1/teams/{teamId}/rental-cars

Accepts a command to create a rental car record.

Required scopes: rental_car:write

Parameters

`path.teamId`required	`string:uuid` Team identifier.
`header.Idempotency-Key`	`string:uuid` Optional caller-generated UUID used to make mutation retries safe. Reuse the same UUID only when retrying the same request.

Request body (application/json)

`companyName`required	`string` Rental car company name.
`label`	`string` Optional short display label.
`confirmationNumber`	`string` Rental booking confirmation number.
`status`required	`"confirmed" \| "unconfirmed"` Rental confirmation state.
`priority`required	`"normal" \| "high"` Rental display priority.
`pickupDate`required	`string` Local rental date in YYYY-MM-DD format at the corresponding rental location.
`pickupTime`required	`string` Local rental time in HH:mm 24-hour format at the corresponding rental location.
`pickupLocation`required	`object` Rental pickup or drop-off location, including its required timezone.
`pickupLocation.label`	`string` Human-readable place label.
`pickupLocation.address`	`string` Street address or venue address.
`pickupLocation.placeId`	`string` Google Places ID when available.
`pickupLocation.latitude`	`number` Latitude in decimal degrees.
`pickupLocation.longitude`	`number` Longitude in decimal degrees.
`pickupLocation.timezone`required	`object` IANA timezone used to interpret and display the rental pickup or drop-off time.
`dropoffDate`required	`string` Local rental date in YYYY-MM-DD format at the corresponding rental location.
`dropoffTime`required	`string` Local rental time in HH:mm 24-hour format at the corresponding rental location.
`dropoffLocation`required	`object` Rental pickup or drop-off location, including its required timezone.
`dropoffLocation.label`	`string` Human-readable place label.
`dropoffLocation.address`	`string` Street address or venue address.
`dropoffLocation.placeId`	`string` Google Places ID when available.
`dropoffLocation.latitude`	`number` Latitude in decimal degrees.
`dropoffLocation.longitude`	`number` Longitude in decimal degrees.
`dropoffLocation.timezone`required	`object` IANA timezone used to interpret and display the rental pickup or drop-off time.
`primaryDriver`	`object` Primary renter or driver.
`primaryDriver.name`required	`string` Contact person's name.
`primaryDriver.title`	`string` Contact person's role or job title.
`primaryDriver.phone`	`string` Contact phone number.
`primaryDriver.email`	`string:email` Contact email address.
`primaryDriver.notes`	`string` Short notes about this contact.
`vehicleClass`	`string` Reserved vehicle class.
`vehicleDescription`	`string` Assigned vehicle or other vehicle details.
`contacts`required	`object[]` Rental company contacts.
`contacts[].name`required	`string` Contact person's name.
`contacts[].title`	`string` Contact person's role or job title.
`contacts[].phone`	`string` Contact phone number.
`contacts[].email`	`string:email` Contact email address.
`contacts[].notes`	`string` Short notes about this contact.
`notes`	`string` General rental notes.
`sourceMetadata`	`object` Integration or import metadata retained with the rental.
`visibility`	`object` Optional rental visibility rules.
`visibility.groupIds`	`string:uuid[]`
`visibility.userIds`	`string:uuid[]`
`id`	`string:uuid` Optional caller-supplied rental car ID. RoadOps generates one when omitted.

Response 202

`commandId`	`string:uuid` Command identifier accepted into the RoadOps command ledger.
`resourceId`	`string:uuid` Identifier of the resource targeted by the command.
`resourceType`	`string` Resource type targeted by the command.
`status`	`"applied"` Command dispatch status.
`aggregateVersion`	`integer` Aggregate version produced by the accepted command.
`cursor`	`integer` Event-ledger cursor for the accepted update. Refetch until returned records reach this cursor.
`links`	`object`
`links.refetch`	`string` Relative URL to refetch the affected resource.

Request: Create rental car

{
  "id": "00000000-0000-4000-8000-000000000923",
  "companyName": "Avis",
  "confirmationNumber": "CAR123",
  "status": "confirmed",
  "priority": "normal",
  "pickupDate": "2026-09-14",
  "pickupTime": "10:00",
  "pickupLocation": {
    "label": "Nashville International Airport",
    "address": "1 Terminal Dr, Nashville, TN",
    "timezone": "America/Chicago"
  },
  "dropoffDate": "2026-09-16",
  "dropoffTime": "09:00",
  "dropoffLocation": {
    "label": "Nashville International Airport",
    "address": "1 Terminal Dr, Nashville, TN",
    "timezone": "America/Chicago"
  },
  "contacts": []
}

Response: Create rental car

{
  "commandId": "00000000-0000-4000-8000-000000000010",
  "resourceId": "00000000-0000-4000-8000-000000000923",
  "resourceType": "rental_car",
  "status": "applied",
  "aggregateVersion": 2,
  "cursor": 87234,
  "links": {
    "refetch": "/v1/teams/00000000-0000-4000-8000-000000000100/rental_cars/00000000-0000-4000-8000-000000000923"
  }
}

Retrieve a rental car

GET/v1/teams/{teamId}/rental-cars/{rentalCarId}

Returns one rental car record by ID.

Required scopes: rental_car:read

Parameters

`path.teamId`required	`string:uuid` Team identifier.
`path.rentalCarId`required	`string:uuid` Rental car identifier.

Response 200

`data`	`object`
`data.companyName`	`string` Rental car company name.
`data.label`	`string` Optional short display label.
`data.confirmationNumber`	`string` Rental booking confirmation number.
`data.status`	`"confirmed" \| "unconfirmed"` Rental confirmation state.
`data.priority`	`"normal" \| "high"` Rental display priority.
`data.pickupDate`	`string` Local rental date in YYYY-MM-DD format at the corresponding rental location.
`data.pickupTime`	`string` Local rental time in HH:mm 24-hour format at the corresponding rental location.
`data.pickupLocation`	`object` Rental pickup or drop-off location, including its required timezone.
`data.pickupLocation.label`	`string` Human-readable place label.
`data.pickupLocation.address`	`string` Street address or venue address.
`data.pickupLocation.placeId`	`string` Google Places ID when available.
`data.pickupLocation.latitude`	`number` Latitude in decimal degrees.
`data.pickupLocation.longitude`	`number` Longitude in decimal degrees.
`data.pickupLocation.timezone`	`object` IANA timezone used to interpret and display the rental pickup or drop-off time.
`data.dropoffDate`	`string` Local rental date in YYYY-MM-DD format at the corresponding rental location.
`data.dropoffTime`	`string` Local rental time in HH:mm 24-hour format at the corresponding rental location.
`data.dropoffLocation`	`object` Rental pickup or drop-off location, including its required timezone.
`data.dropoffLocation.label`	`string` Human-readable place label.
`data.dropoffLocation.address`	`string` Street address or venue address.
`data.dropoffLocation.placeId`	`string` Google Places ID when available.
`data.dropoffLocation.latitude`	`number` Latitude in decimal degrees.
`data.dropoffLocation.longitude`	`number` Longitude in decimal degrees.
`data.dropoffLocation.timezone`	`object` IANA timezone used to interpret and display the rental pickup or drop-off time.
`data.primaryDriver`	`object` Primary renter or driver.
`data.primaryDriver.name`	`string` Contact person's name.
`data.primaryDriver.title`	`string` Contact person's role or job title.
`data.primaryDriver.phone`	`string` Contact phone number.
`data.primaryDriver.email`	`string:email` Contact email address.
`data.primaryDriver.notes`	`string` Short notes about this contact.
`data.vehicleClass`	`string` Reserved vehicle class.
`data.vehicleDescription`	`string` Assigned vehicle or other vehicle details.
`data.contacts`	`object[]` Rental company contacts.
`data.contacts[].name`	`string` Contact person's name.
`data.contacts[].title`	`string` Contact person's role or job title.
`data.contacts[].phone`	`string` Contact phone number.
`data.contacts[].email`	`string:email` Contact email address.
`data.contacts[].notes`	`string` Short notes about this contact.
`data.notes`	`string` General rental notes.
`data.sourceMetadata`	`object` Integration or import metadata retained with the rental.
`data.visibility`	`object` Optional rental visibility rules.
`data.visibility.groupIds`	`string:uuid[]`
`data.visibility.userIds`	`string:uuid[]`
`data.pickupAt`	`string:date-time` Derived UTC pickup timestamp.
`data.dropoffAt`	`string:date-time` Derived UTC drop-off timestamp.
`data.id`	`string:uuid` Rental car identifier.
`data.orgId`	`string:uuid` Team identifier.
`data.isDeleted`	`boolean` Soft-delete flag.
`data.version`	`integer` Current rental car aggregate version.
`data.createdAt`	`string:date-time` ISO 8601 timestamp when the rental car was created.
`data.createdBy`	`string` User identifier that created the rental car.
`data.updatedAt`	`string:date-time` ISO 8601 timestamp of the latest update.
`data.updatedBy`	`string` User identifier that last updated the rental car.
`data.cursor`	`integer` Latest projected event-ledger cursor.
`meta`	`object`
`meta.cursor`	`integer`

Response: Retrieve rental car

{
  "data": {
    "id": "00000000-0000-4000-8000-000000000923",
    "companyName": "Avis",
    "confirmationNumber": "CAR123",
    "status": "confirmed",
    "priority": "normal",
    "pickupDate": "2026-09-14",
    "pickupTime": "10:00",
    "pickupLocation": {
      "label": "Nashville International Airport",
      "address": "1 Terminal Dr, Nashville, TN",
      "timezone": "America/Chicago"
    },
    "dropoffDate": "2026-09-16",
    "dropoffTime": "09:00",
    "dropoffLocation": {
      "label": "Nashville International Airport",
      "address": "1 Terminal Dr, Nashville, TN",
      "timezone": "America/Chicago"
    },
    "contacts": [],
    "orgId": "00000000-0000-4000-8000-000000000100",
    "pickupAt": "2026-09-14T15:00:00.000Z",
    "dropoffAt": "2026-09-16T14:00:00.000Z",
    "isDeleted": false,
    "createdBy": "00000000-0000-4000-8000-000000000101",
    "createdAt": "2026-09-01T12:00:00.000Z",
    "version": 1,
    "cursor": 87235
  },
  "meta": {
    "cursor": 87235
  }
}

Update a rental car

PATCH/v1/teams/{teamId}/rental-cars/{rentalCarId}

Accepts a command to update rental car fields.

Required scopes: rental_car:write

Parameters

`path.teamId`required	`string:uuid` Team identifier.
`path.rentalCarId`required	`string:uuid` Rental car identifier.
`header.Idempotency-Key`	`string:uuid` Optional caller-generated UUID used to make mutation retries safe. Reuse the same UUID only when retrying the same request.

Request body (application/json)

`expectedVersion`	`integer` Optional aggregate version guard.
`updates`required	`object` Rental car fields to update.
`updates.companyName`	`string` Rental car company name.
`updates.label`	`string` Optional short display label.
`updates.confirmationNumber`	`string` Rental booking confirmation number.
`updates.status`	`"confirmed" \| "unconfirmed"` Rental confirmation state.
`updates.priority`	`"normal" \| "high"` Rental display priority.
`updates.pickupDate`	`string` Local rental date in YYYY-MM-DD format at the corresponding rental location.
`updates.pickupTime`	`string` Local rental time in HH:mm 24-hour format at the corresponding rental location.
`updates.pickupLocation`	`object` Rental pickup or drop-off location, including its required timezone.
`updates.pickupLocation.label`	`string` Human-readable place label.
`updates.pickupLocation.address`	`string` Street address or venue address.
`updates.pickupLocation.placeId`	`string` Google Places ID when available.
`updates.pickupLocation.latitude`	`number` Latitude in decimal degrees.
`updates.pickupLocation.longitude`	`number` Longitude in decimal degrees.
`updates.pickupLocation.timezone`required	`object` IANA timezone used to interpret and display the rental pickup or drop-off time.
`updates.dropoffDate`	`string` Local rental date in YYYY-MM-DD format at the corresponding rental location.
`updates.dropoffTime`	`string` Local rental time in HH:mm 24-hour format at the corresponding rental location.
`updates.dropoffLocation`	`object` Rental pickup or drop-off location, including its required timezone.
`updates.dropoffLocation.label`	`string` Human-readable place label.
`updates.dropoffLocation.address`	`string` Street address or venue address.
`updates.dropoffLocation.placeId`	`string` Google Places ID when available.
`updates.dropoffLocation.latitude`	`number` Latitude in decimal degrees.
`updates.dropoffLocation.longitude`	`number` Longitude in decimal degrees.
`updates.dropoffLocation.timezone`required	`object` IANA timezone used to interpret and display the rental pickup or drop-off time.
`updates.primaryDriver`	`object \| null` Updated primary renter or driver, or null to clear the existing primary driver.
`updates.primaryDriver.name`required	`string` Contact person's name.
`updates.primaryDriver.title`	`string` Contact person's role or job title.
`updates.primaryDriver.phone`	`string` Contact phone number.
`updates.primaryDriver.email`	`string:email` Contact email address.
`updates.primaryDriver.notes`	`string` Short notes about this contact.
`updates.vehicleClass`	`string` Reserved vehicle class.
`updates.vehicleDescription`	`string` Assigned vehicle or other vehicle details.
`updates.contacts`	`object[]` Rental company contacts.
`updates.contacts[].name`required	`string` Contact person's name.
`updates.contacts[].title`	`string` Contact person's role or job title.
`updates.contacts[].phone`	`string` Contact phone number.
`updates.contacts[].email`	`string:email` Contact email address.
`updates.contacts[].notes`	`string` Short notes about this contact.
`updates.notes`	`string` General rental notes.
`updates.sourceMetadata`	`object` Integration or import metadata retained with the rental.
`updates.visibility`	`object` Optional rental visibility rules.
`updates.visibility.groupIds`	`string:uuid[]`
`updates.visibility.userIds`	`string:uuid[]`

Response 202

`commandId`	`string:uuid` Command identifier accepted into the RoadOps command ledger.
`resourceId`	`string:uuid` Identifier of the resource targeted by the command.
`resourceType`	`string` Resource type targeted by the command.
`status`	`"applied"` Command dispatch status.
`aggregateVersion`	`integer` Aggregate version produced by the accepted command.
`cursor`	`integer` Event-ledger cursor for the accepted update. Refetch until returned records reach this cursor.
`links`	`object`
`links.refetch`	`string` Relative URL to refetch the affected resource.

Delete a rental car

DELETE/v1/teams/{teamId}/rental-cars/{rentalCarId}

Accepts a command to delete a rental car record.

Required scopes: rental_car:write

Parameters

`path.teamId`required	`string:uuid` Team identifier.
`path.rentalCarId`required	`string:uuid` Rental car identifier.
`header.Idempotency-Key`	`string:uuid` Optional caller-generated UUID used to make mutation retries safe. Reuse the same UUID only when retrying the same request.

Response 202

`commandId`	`string:uuid` Command identifier accepted into the RoadOps command ledger.
`resourceId`	`string:uuid` Identifier of the resource targeted by the command.
`resourceType`	`string` Resource type targeted by the command.
`status`	`"applied"` Command dispatch status.
`aggregateVersion`	`integer` Aggregate version produced by the accepted command.
`cursor`	`integer` Event-ledger cursor for the accepted update. Refetch until returned records reach this cursor.
`links`	`object`
`links.refetch`	`string` Relative URL to refetch the affected resource.