Inspections

You should have the API Key while retrieving or updating your data. Without these API keys, you cannot access your inspections.

Inspection object

Top level

{
  "id": "74d5c338-9828-474f-a383-934196ab121e",
  "name": "Sunshine Appartment - Unit #7",
  "status": "completed",
  "description": "Yearly  property inspection",
  "created_at": "2023-04-05T20:41:42.8660000Z",
  "created_by": {},
  "updated_at": "2023-04-05T20:41:42.8660000Z",
  "updated_by": {},
  "timezone": "Eastern Standard Time|GMT-04:00",
  "custom_fields": [{}],
  "custom_fields_count": 0,
  "team": {},
  "template": {},
  "locations": [{}],
  "shared_with_users": [{}],
  "shared_with_users_count": 0,
  "files": [{}],
  "files_count": 0,
  "data": {}
}

Key	Type	Description
id	String	A unique identifier for the inspection.
name	String	The name or title of the inspection.
status	String	The current status of the inspection. One the the following: `in_progress` or `completed`
description	String	Additional information or details about the inspection.
created_at	String	The timestamp when the inspection was created in ISO 8601 date and time format.
created_by	Object	Information about the user who created the inspection.
updated_at	String	The timestamp when the inspection was last updated in ISO 8601 date and time format.
updated_by	Object	Information about the user who last updated the inspection.
timezone	String	The timezone in which the inspection was conducted.
custom_fields	Array	An array of object(s) containing custom fields associated with the inspection.
custom_fields_count	Number	The count of custom fields associated with the inspection.
team	Object	Information about the team associated with the inspection.
template	Object	Information about the template used for the inspection.
locations	Array	An array of object(s) containing location object(s) for the inspection. This information is crucial for verifying the inspection conducting site and generating KYPiT reports.
shared_with_users	Array	An array of shared user object(s) containing information about the users with whom the inspection has been shared.
shared_with_users_count	Number	The count of users with whom the inspection has been shared.
files	Array	An array of file object(s) containing information about files associated with the inspection.
files_count	Number	The count of files associated with the inspection.
data	Object	Inspection data object (question_responses or posts)

Inspection data object

Top level

{
  "item_type": "question_response",
  "items_count": 1,
  "items": [{}]
}

Key	Type	Description
item_type	String	Specifies the type of items contained within the data object. One of the following: `question_responses` or `posts`
items_count	Number	The count of items contained within the items array.
items	Array	An array of item object(s) representing individual items or responses of the inspection.

Item object (Inspection Data)

The below object is only forquestion_responses item_type.

{
  "id": "1e349cac-4bbc-4547-bf66-18ea436e2b4b",
  "template_control_id": "54a5a217-c261-48f5-8c40-8e85631d28b3",
  "path": "Generat Information/Conducted By(Name):",
  "type": "text",
  "label": "Conducted By(Name):",
  "response": {
    "value": "Eric Smith"
  },
  "parent_id": "a7544213-c293-4db3-96e8-3c9b5c946e0c",
  "repeat_section_order": 1,
  "notes": "",
  "file_ids_count": 0,
  "file_ids": [],
  "created_at": "2023-04-05T20:41:42.8660000Z",
  "updated_at": "2023-04-05T20:41:42.8660000Z",
  "created_by": {},
  "updated_by": {}
}

Key	Type	Description
id	String	A unique identifier for the item.
template_control_id	String	A unique identifier for the control in the inspection template to which this item corresponds.
path	String	The path or location within the template where this control is located.
type	String	The type of control in the inspection template. One of the following: `text`, `number`, `radio`, `checkbox`, `dropdown`, `date`, `media`, `signature`, `barcode`, `checkin`, `instacount`, `instructions`
label	String	The label or title of the control (question text).
response	Object	An array of response object containing the response data for the control.
parent_id	String	The identifier of the parent control if this control is nested within another control.
repeat_section_order	Number	Indicates the order of appearance for controls in a repeated section, if applicable.
notes	String	Additional notes or comments associated with the control.
file_ids_count	Number	The count of file attachments associated with the item.
file_ids	Array	An array containing the identifiers of the file associated with the item.
created_at	String	The timestamp when the item was created in ISO 8601 date and time format.
updated_at	String	The timestamp when the item was last updated in ISO 8601 date and time format.
created_by	Object	Information about the user who created the item.
updated_by	Object	Information about the user who last updated the item.

Response object

 {
  "id": "599f7724-f1d8-4fb2-825d-07a66b4f227c",
  "value": "Good",
  "color": "#3fff21",
  "score": 2,
  "isFlagged": false,
  "reference_id": "CS_25_01"
}

Key	Type	Description
id	String	Unique identifier for options/custom_set items // Excluded if question doesn't use custom set
value	String	The user's response to the question.
color	String	The color associated with that control.
score	Number	Score for the selected response(it will be included only if the question is scoreable)
isFlagged	Boolean	Flag value for the user's response.
reference_id	String	Custom reference ID for the custom set item (it will be included only if the question uses a custom set)

Note: To know more about what the scoring, flagging, and color coding features are, visit this link - Scoring, Flagging & Color Coding.

User object (General Information only)

{
  "id": "7348c321-8636-453d-a9b2-327ad7c4f5ce",
  "name": "John Doe",
  "email": "[email protected]"
}

Key	Type	Description
id	String	A unique identifier for the user.
name	String	The name of the user.
email	String	The email address of the user.

Custom Field object

Note: Currently, we only support Custom Reference Id key for the custom fields.

{
  "name": "Custom Reference Id",
  "value": "432443"
}

Key	Type	Description
name	String	Name or Key of the custom field.
value	String	Value of the custom field.

Team object (General Information only)

{
  "id": "7348c321-8636-453d-a9b2-327ad7c4f5ce",
  "name": "Maintenance Team"
}

Key	Type	Description
id	String	A unique identifier for the team.
name	String	Name of the team.

Template object (General Information only)

This object only contains general information about the template. For comprehensive details on the complete template object, please refer to Template Object

{
  "id": "5fda16a7-c870-4440-a1ef-1c560c6b65bd",
  "name": "Real Estate Property Inspection"
}

Key	Type	Description
id	String	A unique identifier for the template.
name	String	Name of the template.

Location object

{
  "location": "20803 Biscayne Blvd, Aventura, FL 33180, USA",
  "latitude": 25.9685082,
  "longitude": -80.14312
}

Key	Type	Description
location	String	The address of the specific location.
latitude	Float	The latitude coordinate of the location.
longitude	Float	The longitude coordinate of the location.

Shared User object (General Information only)

{
  "id": "12eb2694-ce8c-4caa-9b3d-130a7ec505c9",
  "name": "Eric Smith",
  "email": "[email protected]",
  "role": "contributor"
}

Key	Type	Description
id	String	A unique identifier for the shared user.
name	String	The name of the shared user.
email	String	The email address of the shared user.
role	String	The role assigned to the shared user within the context of the inspection. One the the following: `viewer`, `contributor`, `assignee`

File object

Top level

{
  "id": "90a6955f-bdb7-4c2d-a988-f6e614bfa294",
  "name": "Capture_1680727303.jpg",
  "url": "https://bit.ly/3nLsHFw",
  "size": "46245",
  "created_at": "2023-04-05T20:41:42.8660000Z",
  "updated_at": "2023-04-05T20:41:42.8660000Z",
  "type": "image",
  "source": {},
  "created_by": {},
  "updated_by": {}
}

Key	Type	Description
id	String	A unique identifier for the file.
name	String	The name of the file.
url	String	The URL where the file can be accessed or downloaded.
size	Long	The size of the file(in bytes).
created_at	String	The timestamp when the file was created in ISO 8601 date and time format.
updated_at	String	The timestamp when the file was last updated in ISO 8601 date and time format.
type	String	The type of the file. One of the following: `image`, `audio`, `video`, `instacount`, `attachment`
source	Object	Information about the source of the file.
created_by	Object	Information about the user who created the file.
updated_by	Object	Information about the user who last updated the file.

Source object

{
  "platform": "Web App",
  "os": "Mac OS X 10.15.7",
  "type": "captured"
}

Key	Type	Description
platform	String	The platform from which the file was sourced.
os	String	The operating system used on the platform from which the file was sourced.
type	String	The type of source. One of the following: `captured` or `uploaded`