Read

Read

Returns information on a measure sheet, including its measurements. 

Request

Method
URL
POST

Headers

Name
Required
Type
Description
APIKey
Guid
A valid API key with a scope of MeasureSheets | Read

Body

Name
Required
Type
Description
MeasureSheetUniqueID
GUID
The unique ID of the measure sheet.
{
"MeasureSheetUniqueID": "cd929a27-2492-4bdd-bda5-e1fa8ff0b9b3"
}

Remarks

None

Response

Headers

None

Status Code

Code
Description
200 OK
The measure sheet was read.
400 Bad Request
The measure sheet could not be read. The reason why will be returned.
401 Unauthorized
The API key is missing, invalid, disabled, or does not have the correct scope.
404 Not Found
The measure sheet was not found.

Body

Property
Type
Description
CustomerUniqueID
GUID
The unique ID of the customer that the measure sheet belongs to.
CustomerExternalID
Text
The external ID of the customer that the measure sheet belongs to.
Location
Text
The measure sheet's location.
UserName
Text
The name of the user that added the measure sheet.
AddedOn
Date
The date and time when the measure sheet was added.
UpdatedOn
Date
The date and time when the measure sheet was last updated.
UniqueID
GUID
The unique ID of the measure sheet.
Measurements
Object Array
The measurements associated with the measure sheet. See Measurements in the Create endpoint for an explanation of this format.
{
"customerUniqueID": "a7d5ede2-35ba-410c-8523-1f6b6b0737a5",
"customerExternalID": "",
"location": "Primary House",
"userName": "",
"addedOn": "2025-08-20T17:42:06.817",
"updatedOn": "2025-08-20T17:42:06.817",
"uniqueID": "78bec51b-6b8e-4062-9d34-b6e1f592000d",
"measurements": [
{
"room": "Kitchen",
"item": "Window 1",
"mount": "Inside",
"width": "25 1/2",
"height": "55",
"remarks": "This window is not square.",
"otherMeasurements": null
},
{
"room": "Kitchen",
"item": "Window 2",
"mount": "Inside",
"width": "25",
"height": "55.25",
"remarks": "",
"otherMeasurements": {
"W1": "55",
"W2": "55.5",
"W3": "55.75"
}
}
]
}