RoadOpsDeveloper

Lodging

Ask

List lodging

GET/v1/teams/{teamId}/lodging

Lists lodging records for a team.

Required scopes: lodging:read

Parameters

path.teamIdrequiredstring:uuid

Team identifier.

query.datestring:date

Optional local date filter in YYYY-MM-DD format. Returns lodging records whose local check-in/check-out date range overlaps this date.

query.limitinteger

Maximum number of records to return. Defaults to 50 and is capped at 200.

query.cursorstring

Cursor returned by page.nextCursor from the previous list response.

Response 200

dataobject[]
data[].namestring

Lodging record display name.

data[].labelstring | null

Optional lodging label displayed above the lodging name.

data[].sortOrderinteger | null

Optional numeric sort order for ordering lodging records.

data[].confirmationNumberstring

Hotel confirmation number.

data[].locationobject

Hotel or lodging location details.

data[].location.namestring

Hotel or lodging location display name.

data[].location.addressstring

Street address or human-readable lodging location address.

data[].location.placeIdstring

Google Places ID when available.

data[].location.latitudenumber

Optional lodging latitude in decimal degrees.

data[].location.longitudenumber

Optional lodging longitude in decimal degrees.

data[].location.timezoneobject

IANA timezone identifier for the lodging location, such as America/Chicago. RoadOps uses this timezone to display check-in and check-out UTC timestamps in local time.

data[].checkInTimestring

ISO 8601 UTC timestamp for the lodging event. Send the timestamp in UTC, typically ending in Z; RoadOps uses location.timezone to display the corresponding local time in the app.

data[].checkOutTimestring

ISO 8601 UTC timestamp for the lodging event. Send the timestamp in UTC, typically ending in Z; RoadOps uses location.timezone to display the corresponding local time in the app.

data[].contactobject

Primary lodging contact.

data[].contact.namestring

Contact person's name.

data[].contact.titlestring

Contact person's role or job title.

data[].contact.phonestring

Contact phone number.

data[].contact.emailstring:email

Contact email address.

data[].contact.notesstring

Short notes about this contact.

data[].contactsobject[]

Additional lodging contacts.

data[].contacts[].namestring

Contact person's name.

data[].contacts[].titlestring

Contact person's role or job title.

data[].contacts[].phonestring

Contact phone number.

data[].contacts[].emailstring:email

Contact email address.

data[].contacts[].notesstring

Short notes about this contact.

data[].roomCountinteger

Expected number of rooms reserved for this lodging block.

data[].roomsobject[]

Rooming-list entries associated with this lodging record.

data[].rooms[].idstring:uuid

Stable room identifier.

data[].rooms[].roomTypestring

Room type or rooming-list label, such as King, Double Queen, or Bus room.

data[].rooms[].roomNumberstring

Assigned room number, when known.

data[].rooms[].bagTagstring

Bag tag or luggage label associated with this room.

data[].rooms[].confirmationNumberstring

Room-specific confirmation number, when different from the lodging record.

data[].rooms[].checkInDatestring

Room-specific check-in date in YYYY-MM-DD format, in the lodging timezone.

data[].rooms[].etastring

Estimated room arrival time in HH:mm 24-hour local time.

data[].rooms[].checkOutDatestring

Room-specific check-out date in YYYY-MM-DD format, in the lodging timezone.

data[].rooms[].etdstring

Estimated room departure time in HH:mm 24-hour local time.

data[].rooms[].occupantsstring

Names or notes identifying the people assigned to this room.

data[].rooms[].notesstring

Room-specific notes.

data[].notesstring

General lodging notes.

data[].sourceMetadataobject

Optional integration metadata retained with the lodging record.

data[].visibilityobject

Optional visibility rules for the lodging record.

data[].visibility.groupIdsstring:uuid[]
data[].visibility.userIdsstring:uuid[]
data[].idstring:uuid
data[].orgIdstring:uuid
data[].isDeletedboolean
data[].versioninteger

Current lodging aggregate version.

data[].createdAtstring:date-time

ISO 8601 timestamp when the lodging record was created.

data[].createdBystring

User identifier that created the lodging record.

data[].updatedAtstring:date-time

ISO 8601 timestamp when the lodging record was last updated.

data[].updatedBystring

User identifier that last updated the lodging record.

data[].cursorinteger

Latest event-ledger cursor projected into this lodging record.

pageobject
page.limitinteger

Maximum number of records returned in this page.

page.nextCursorstring | null

Cursor to pass as the next request's cursor query parameter, or null when there are no more results.

metaobject
meta.cursornumber | null

Highest record cursor represented by this response.

Create lodging

POST/v1/teams/{teamId}/lodging

Accepts a command to create a lodging record.

Required scopes: lodging:write

Parameters

path.teamIdrequiredstring:uuid

Team identifier.

header.Idempotency-Keystring: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)

namerequiredstring

Lodging record display name.

labelstring | null

Optional lodging label displayed above the lodging name.

sortOrderinteger | null

Optional numeric sort order for ordering lodging records.

confirmationNumberstring

Hotel confirmation number.

locationrequiredobject

Hotel or lodging location details.

location.namestring

Hotel or lodging location display name.

location.addressrequiredstring

Street address or human-readable lodging location address.

location.placeIdstring

Google Places ID when available.

location.latitudenumber

Optional lodging latitude in decimal degrees.

location.longitudenumber

Optional lodging longitude in decimal degrees.

location.timezoneobject

IANA timezone identifier for the lodging location, such as America/Chicago. RoadOps uses this timezone to display check-in and check-out UTC timestamps in local time.

checkInTimerequiredstring

ISO 8601 UTC timestamp for the lodging event. Send the timestamp in UTC, typically ending in Z; RoadOps uses location.timezone to display the corresponding local time in the app.

checkOutTimerequiredstring

ISO 8601 UTC timestamp for the lodging event. Send the timestamp in UTC, typically ending in Z; RoadOps uses location.timezone to display the corresponding local time in the app.

contactobject

Primary lodging contact.

contact.namerequiredstring

Contact person's name.

contact.titlestring

Contact person's role or job title.

contact.phonestring

Contact phone number.

contact.emailstring:email

Contact email address.

contact.notesstring

Short notes about this contact.

contactsrequiredobject[]

Additional lodging contacts.

contacts[].namerequiredstring

Contact person's name.

contacts[].titlestring

Contact person's role or job title.

contacts[].phonestring

Contact phone number.

contacts[].emailstring:email

Contact email address.

contacts[].notesstring

Short notes about this contact.

roomCountinteger

Expected number of rooms reserved for this lodging block.

roomsrequiredobject[]

Rooming-list entries associated with this lodging record.

rooms[].idrequiredstring:uuid

Stable room identifier.

rooms[].roomTyperequiredstring

Room type or rooming-list label, such as King, Double Queen, or Bus room.

rooms[].roomNumberstring

Assigned room number, when known.

rooms[].bagTagstring

Bag tag or luggage label associated with this room.

rooms[].confirmationNumberstring

Room-specific confirmation number, when different from the lodging record.

rooms[].checkInDatestring

Room-specific check-in date in YYYY-MM-DD format, in the lodging timezone.

rooms[].etastring

Estimated room arrival time in HH:mm 24-hour local time.

rooms[].checkOutDatestring

Room-specific check-out date in YYYY-MM-DD format, in the lodging timezone.

rooms[].etdstring

Estimated room departure time in HH:mm 24-hour local time.

rooms[].occupantsstring

Names or notes identifying the people assigned to this room.

rooms[].notesstring

Room-specific notes.

notesstring

General lodging notes.

sourceMetadataobject

Optional integration metadata retained with the lodging record.

visibilityobject

Optional visibility rules for the lodging record.

visibility.groupIdsstring:uuid[]
visibility.userIdsstring:uuid[]
idstring:uuid

Optional caller-supplied lodging ID. RoadOps generates one when omitted.

Response 202

commandIdstring:uuid

Command identifier accepted into the RoadOps command ledger.

resourceIdstring:uuid

Identifier of the resource targeted by the command.

resourceTypestring

Resource type targeted by the command.

status"applied"

Command dispatch status.

aggregateVersioninteger

Aggregate version produced by the accepted command.

cursorinteger

Event-ledger cursor for the accepted update. Refetch until returned records reach this cursor.

linksobject
links.refetchstring

Relative URL to refetch the affected resource.

Retrieve lodging

GET/v1/teams/{teamId}/lodging/{lodgingId}

Returns one lodging record by ID.

Required scopes: lodging:read

Parameters

path.teamIdrequiredstring:uuid

Team identifier.

path.lodgingIdrequiredstring:uuid

Lodging identifier.

Response 200

dataobject
data.namestring

Lodging record display name.

data.labelstring | null

Optional lodging label displayed above the lodging name.

data.sortOrderinteger | null

Optional numeric sort order for ordering lodging records.

data.confirmationNumberstring

Hotel confirmation number.

data.locationobject

Hotel or lodging location details.

data.location.namestring

Hotel or lodging location display name.

data.location.addressstring

Street address or human-readable lodging location address.

data.location.placeIdstring

Google Places ID when available.

data.location.latitudenumber

Optional lodging latitude in decimal degrees.

data.location.longitudenumber

Optional lodging longitude in decimal degrees.

data.location.timezoneobject

IANA timezone identifier for the lodging location, such as America/Chicago. RoadOps uses this timezone to display check-in and check-out UTC timestamps in local time.

data.checkInTimestring

ISO 8601 UTC timestamp for the lodging event. Send the timestamp in UTC, typically ending in Z; RoadOps uses location.timezone to display the corresponding local time in the app.

data.checkOutTimestring

ISO 8601 UTC timestamp for the lodging event. Send the timestamp in UTC, typically ending in Z; RoadOps uses location.timezone to display the corresponding local time in the app.

data.contactobject

Primary lodging contact.

data.contact.namestring

Contact person's name.

data.contact.titlestring

Contact person's role or job title.

data.contact.phonestring

Contact phone number.

data.contact.emailstring:email

Contact email address.

data.contact.notesstring

Short notes about this contact.

data.contactsobject[]

Additional lodging contacts.

data.contacts[].namestring

Contact person's name.

data.contacts[].titlestring

Contact person's role or job title.

data.contacts[].phonestring

Contact phone number.

data.contacts[].emailstring:email

Contact email address.

data.contacts[].notesstring

Short notes about this contact.

data.roomCountinteger

Expected number of rooms reserved for this lodging block.

data.roomsobject[]

Rooming-list entries associated with this lodging record.

data.rooms[].idstring:uuid

Stable room identifier.

data.rooms[].roomTypestring

Room type or rooming-list label, such as King, Double Queen, or Bus room.

data.rooms[].roomNumberstring

Assigned room number, when known.

data.rooms[].bagTagstring

Bag tag or luggage label associated with this room.

data.rooms[].confirmationNumberstring

Room-specific confirmation number, when different from the lodging record.

data.rooms[].checkInDatestring

Room-specific check-in date in YYYY-MM-DD format, in the lodging timezone.

data.rooms[].etastring

Estimated room arrival time in HH:mm 24-hour local time.

data.rooms[].checkOutDatestring

Room-specific check-out date in YYYY-MM-DD format, in the lodging timezone.

data.rooms[].etdstring

Estimated room departure time in HH:mm 24-hour local time.

data.rooms[].occupantsstring

Names or notes identifying the people assigned to this room.

data.rooms[].notesstring

Room-specific notes.

data.notesstring

General lodging notes.

data.sourceMetadataobject

Optional integration metadata retained with the lodging record.

data.visibilityobject

Optional visibility rules for the lodging record.

data.visibility.groupIdsstring:uuid[]
data.visibility.userIdsstring:uuid[]
data.idstring:uuid
data.orgIdstring:uuid
data.isDeletedboolean
data.versioninteger

Current lodging aggregate version.

data.createdAtstring:date-time

ISO 8601 timestamp when the lodging record was created.

data.createdBystring

User identifier that created the lodging record.

data.updatedAtstring:date-time

ISO 8601 timestamp when the lodging record was last updated.

data.updatedBystring

User identifier that last updated the lodging record.

data.cursorinteger

Latest event-ledger cursor projected into this lodging record.

metaobject
meta.cursorinteger

Highest record cursor represented by this response.

Update lodging

PATCH/v1/teams/{teamId}/lodging/{lodgingId}

Accepts a command to update lodging fields.

Required scopes: lodging:write

Parameters

path.teamIdrequiredstring:uuid

Team identifier.

path.lodgingIdrequiredstring:uuid

Lodging identifier.

header.Idempotency-Keystring: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)

expectedVersioninteger

Optional aggregate version guard.

updatesrequiredobject

Lodging fields to update.

updates.namestring

Updated lodging display name.

updates.labelstring | null

Updated lodging label displayed above the lodging name, or null to clear it.

updates.sortOrderinteger | null

Updated numeric sort order for ordering lodging records, or null to clear it.

updates.confirmationNumberstring | null

Updated hotel confirmation number, or null to clear it.

updates.locationobject

Updated hotel or lodging location details.

updates.location.namestring

Hotel or lodging location display name.

updates.location.addressrequiredstring

Street address or human-readable lodging location address.

updates.location.placeIdstring

Google Places ID when available.

updates.location.latitudenumber

Optional lodging latitude in decimal degrees.

updates.location.longitudenumber

Optional lodging longitude in decimal degrees.

updates.location.timezoneobject

IANA timezone identifier for the lodging location, such as America/Chicago. RoadOps uses this timezone to display check-in and check-out UTC timestamps in local time.

updates.checkInTimestring

Updated ISO 8601 UTC check-in timestamp. Send the timestamp in UTC, typically ending in Z; RoadOps uses location.timezone to display the corresponding local time in the app.

updates.checkOutTimestring

Updated ISO 8601 UTC check-out timestamp. Send the timestamp in UTC, typically ending in Z; RoadOps uses location.timezone to display the corresponding local time in the app.

updates.contactobject | null

Updated primary lodging contact, or null to clear it.

updates.contact.namestring

Contact person's name.

updates.contact.titlestring

Contact person's role or job title.

updates.contact.phonestring

Contact phone number.

updates.contact.emailstring:email

Contact email address.

updates.contact.notesstring

Short notes about this contact.

updates.contactsobject[]

Updated additional lodging contacts.

updates.contacts[].namerequiredstring

Contact person's name.

updates.contacts[].titlestring

Contact person's role or job title.

updates.contacts[].phonestring

Contact phone number.

updates.contacts[].emailstring:email

Contact email address.

updates.contacts[].notesstring

Short notes about this contact.

updates.roomCountinteger | null

Updated expected room count, or null to clear it.

updates.roomsobject[]

Updated rooming-list entries.

updates.rooms[].idrequiredstring:uuid

Stable room identifier.

updates.rooms[].roomTyperequiredstring

Room type or rooming-list label, such as King, Double Queen, or Bus room.

updates.rooms[].roomNumberstring

Assigned room number, when known.

updates.rooms[].bagTagstring

Bag tag or luggage label associated with this room.

updates.rooms[].confirmationNumberstring

Room-specific confirmation number, when different from the lodging record.

updates.rooms[].checkInDatestring

Room-specific check-in date in YYYY-MM-DD format, in the lodging timezone.

updates.rooms[].etastring

Estimated room arrival time in HH:mm 24-hour local time.

updates.rooms[].checkOutDatestring

Room-specific check-out date in YYYY-MM-DD format, in the lodging timezone.

updates.rooms[].etdstring

Estimated room departure time in HH:mm 24-hour local time.

updates.rooms[].occupantsstring

Names or notes identifying the people assigned to this room.

updates.rooms[].notesstring

Room-specific notes.

updates.notesstring | null

Updated lodging notes, or null to clear them.

updates.visibilityobject | null

Updated visibility rules, or null to clear them.

updates.visibility.groupIdsstring:uuid[]
updates.visibility.userIdsstring:uuid[]

Response 202

commandIdstring:uuid

Command identifier accepted into the RoadOps command ledger.

resourceIdstring:uuid

Identifier of the resource targeted by the command.

resourceTypestring

Resource type targeted by the command.

status"applied"

Command dispatch status.

aggregateVersioninteger

Aggregate version produced by the accepted command.

cursorinteger

Event-ledger cursor for the accepted update. Refetch until returned records reach this cursor.

linksobject
links.refetchstring

Relative URL to refetch the affected resource.

Delete lodging

DELETE/v1/teams/{teamId}/lodging/{lodgingId}

Accepts a command to delete a lodging record.

Required scopes: lodging:write

Parameters

path.teamIdrequiredstring:uuid

Team identifier.

path.lodgingIdrequiredstring:uuid

Lodging identifier.

header.Idempotency-Keystring:uuid

Optional caller-generated UUID used to make mutation retries safe. Reuse the same UUID only when retrying the same request.

Response 202

commandIdstring:uuid

Command identifier accepted into the RoadOps command ledger.

resourceIdstring:uuid

Identifier of the resource targeted by the command.

resourceTypestring

Resource type targeted by the command.

status"applied"

Command dispatch status.

aggregateVersioninteger

Aggregate version produced by the accepted command.

cursorinteger

Event-ledger cursor for the accepted update. Refetch until returned records reach this cursor.

linksobject
links.refetchstring

Relative URL to refetch the affected resource.