Read Turn

1 curl -G https://api.fortresstech.io/v1/turns/turnId \ 2 --data-urlencode fields=id,name,property.*,documents.type

1 { 2 "scheduledDate": "scheduledDate", 3 "actualEndDate": "actualEndDate", 4 "actualStartDate": "actualStartDate", 5 "createdAt": "2024-01-15T09:30:00Z", 6 "deletedAt": "2024-01-15T09:30:00Z", 7 "id": "id", 8 "idempotencyId": "idempotencyId", 9 "organizationId": "organizationId", 10 "readableId": "readableId", 11 "scheduledEndDate": "scheduledEndDate", 12 "scheduledStartDate": "scheduledStartDate", 13 "status": "SCHEDULED", 14 "unit": { 15 "number": "number", 16 "floorLevel": "floorLevel", 17 "isADA": true, 18 "status": "VACANT_READY", 19 "floorPlanId": "floorPlanId", 20 "propertyId": "propertyId", 21 "organizationId": "organizationId", 22 "buildingId": "buildingId", 23 "currentHouseholdId": "currentHouseholdId", 24 "lastMoveOutId": "lastMoveOutId", 25 "priorLeaseId": "priorLeaseId", 26 "id": "id", 27 "readableId": "readableId", 28 "idempotencyId": "idempotencyId", 29 "createdAt": "2024-01-15T09:30:00Z", 30 "updatedAt": "2024-01-15T09:30:00Z", 31 "deletedAt": "2024-01-15T09:30:00Z", 32 "vacantSince": "2024-01-15T09:30:00Z", 33 "reportOrder": 1.1, 34 "makeReadyDate": "makeReadyDate", 35 "reportConfigurationValue": "Quoting Rent", 36 "lastVacancyStartDate": "lastVacancyStartDate", 37 "mostRecentApplicationId": "mostRecentApplicationId" 38 }, 39 "unitId": "unitId", 40 "updatedAt": "2024-01-15T09:30:00Z" 41 }

Available by Request

Info for a specific turn

This endpoint is part of our evolving API ecosystem. To explore availability for your integration, please contact our team.

<Badge>Available by Request</Badge> Info for a specific turn <Note> This endpoint is part of our evolving API ecosystem. To explore availability for your integration, please contact our team. </Note>

Path parameters

turnIdstringRequired

The id of the turn

Query parameters

fieldsstringOptionalformat: "^([a-zA-Z\.],?)+$"

Specific fields requested in the response. Defaults to all fields.

Response

Expected response to a valid request

scheduledDatestringformat: "date"

actualEndDatestring or nullformat: "date"

actualStartDatestring or nullformat: "date"

createdAtdatetime or null

deletedAtdatetime or null

idstring or nullformat: "uuid"

idempotencyIdstring or nullformat: "uuid"

organizationIdstring or nullformat: "uuid"

readableIdstring or null

scheduledEndDatestring or nullformat: "date"

scheduledStartDatestring or nullformat: "date"

statusenum or null

Allowed values:

unitobject or null

unitIdstring or nullformat: "uuid"

updatedAtdatetime or null