Rentals

GET rental activities

Get a list of activities for a rental. The activities include most major things in a rentals life cycle - both confirmed things that have already happened, as well as anticipated future activities.

get/rentals/{rental_id}/activities

Request

  • Base URL: https://api.equipmentshare.com (the document declares no server; this is the origin it was published from)
  • URL: https://api.equipmentshare.com/rentals/{rental_id}/activities
  • Auth: HTTP bearer

Path parameters

rental_idinteger required

The ID of the rental to get activities for.

Query parameters

typestring[]

Only return activities of this type.

startinteger

Only return activities happening after this timestamp.

endinteger

Only return activities happening before this timestamp.

market_idinteger[]

Only return activities happening in this market/branch (or list of markets/branches, several are allowed).

statestring[]

Only return activities in this state.

Response

dataobject

Additional data related to the rental activity.

datestring required

Timestamp of when the activity occurred or is expected to occur.

rental_idinteger required

ID of the rental.

statestring required

State of the rental activity.

typestring required

Type of the rental activity.

Changes

No recorded changes to this operation across all 1 revision of this API.