{"openapi":"3.0.0","info":{"title":"Vision API - V3","description":"Truepic Vision is a digital inspection platform that provides a quick and convenient way to receive verified, trustworthy images directly from your customer. We offer you the same trusted result as traditional site inspections, but get it done virtually — saving you time, money, and productivity in the process.\n\nTo begin using our API, please contact us to request access. We will issue you a `client_id` and `client_secret` for authorization, as well as team and inspection type IDs that you will need when making requests.\n\nAuthorization is done via OAuth 2's [client credentials flow](https://auth0.com/docs/flows/concepts/client-credentials). Click the \"Authorize\" button below for more details.\n","contact":{"name":"Truepic","email":"support@truepic.com"},"version":"3.74.0"},"servers":[{"url":"https://vision-api.truepic.{tld}/v3","description":"Production","variables":{"tld":{"default":"com","enum":["com","uk"],"description":"Select the tld for your region. Use \"com\" for US region, \"uk\" for EU region."}}}],"components":{"parameters":{"organizationId":{"name":"organizationId","in":"path","description":"The ID of the existing organization.","required":true,"schema":{"type":"integer","example":123}},"inspectionId":{"name":"inspectionId","in":"path","description":"The ID of the existing inspection request.","required":true,"schema":{"type":"integer","example":123}},"listId":{"name":"listId","in":"path","description":"The ID of the existing list.","required":true,"schema":{"type":"integer","example":123}},"listItemId":{"name":"listItemId","in":"path","description":"The ID of the existing list item (entry in a list).","required":true,"schema":{"type":"integer","example":123}},"operationId":{"name":"operationId","in":"path","description":"The ID of the existing operation.","required":true,"schema":{"type":"integer","example":123}},"userId":{"name":"userId","in":"path","description":"The ID of the existing user.","required":true,"schema":{"type":"integer","example":123}},"verificationCode":{"name":"verificationCode","in":"path","description":"The unique alphanumeric identifier of the photo/video.","required":true,"schema":{"type":"string","example":"a8ic9o07p1"}},"page":{"name":"page","in":"query","style":"deepObject","description":"Pagination to limit the number of results returned.\n\nDefaults to the first page of 20 results, with a maximum of 100 results per page.\n","schema":{"type":"object","properties":{"number":{"type":"integer","description":"The page number to return.\n\nDefaults to 1.\n","example":3},"size":{"type":"integer","description":"The number of results to return per page.\n\nDefaults to 20, with a maximum of 100.\n","example":25}}}}},"responses":{"ErrorBadRequest":{"description":"The request body couldn't be parsed.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ResponseData"},"example":{"response_code":400,"message":"Inspection ID missing","api_version":"3.0.0"}}}},"ErrorUnauthorized":{"description":"Authentication failed, or the user/client doesn't have permission to the requested resource.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ResponseData"},"example":{"response_code":401,"message":"Unauthorized","api_version":"3.0.0"}}}},"ErrorForbidden":{"description":"The user doesn't have permission to access the requested resource.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ResponseData"},"example":{"response_code":403,"message":"Forbidden","api_version":"3.0.0"}}}},"ErrorNotFound":{"description":"The requested resource couldn't be found.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ResponseData"},"example":{"response_code":404,"message":"Not Found","api_version":"3.0.0"}}}},"ErrorPreconditionFailed":{"description":"A required property or parameter is missing from the request.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ResponseData"},"example":{"response_code":412,"message":"Not a mobile number","api_version":"3.0.0"}}}},"ErrorUnhandled":{"description":"An unexpected error occurred.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ResponseData"},"example":{"response_code":500,"message":"An error occurred","api_version":"3.0.0"}}}}},"schemas":{"AIAnalysisSet":{"additionalProperties":false,"properties":{"created_at":{"description":"The date/time the resource was created","example":"2020-05-01T21:44:40.000Z","format":"date-time","type":"string"},"created_by_user_id":{"description":"The id of the user that created this AI Analysis Set.","example":894,"type":"number"},"id":{"description":"The id of the resource.","example":1843,"type":"number"},"is_deleted":true,"modified_by_user_id":{"description":"The id of the user that last edited this AI Analysis Set.","example":542,"type":"number"},"name":{"description":"The name of the AI Analysis Set","example":"AI Analysis Set Name","type":"string"},"organization_id":{"description":"The id of the organization that owns this AI Analysis Set","example":532,"type":"number"},"updated_at":{"description":"The date/time the resource was last updated","example":"2020-05-01T21:44:40.000Z","format":"date-time","type":"string"}},"required":["created_at","created_by_user_id","id","is_deleted","name","organization_id","updated_at"],"type":"object"},"AIAnalysisSetPayload":{"additionalProperties":false,"properties":{"created_at":{"description":"The date/time the resource was created","example":"2020-05-01T21:44:40.000Z","format":"date-time","type":"string"},"created_by_user_id":{"description":"The id of the user that created this AI Analysis Set.","example":894,"type":"number"},"id":{"description":"The id of the resource.","example":1843,"type":"number"},"is_deleted":true,"modified_by_user_id":{"description":"The id of the user that last edited this AI Analysis Set.","example":542,"type":"number"},"name":{"description":"The name of the AI Analysis Set","example":"AI Analysis Set Name","type":"string"},"organization_id":{"description":"The id of the organization that owns this AI Analysis Set","example":532,"type":"number"},"questions":{"items":{"type":"string"},"type":"array"},"updated_at":{"description":"The date/time the resource was last updated","example":"2020-05-01T21:44:40.000Z","format":"date-time","type":"string"}},"required":["created_at","created_by_user_id","id","is_deleted","name","organization_id","questions","updated_at"],"type":"object"},"AIInspectionCriteriaEvaluationModelResultV1":{"additionalProperties":false,"properties":{"cachedTokens":{"type":"number"},"discrepancies":{"items":{"$ref":"#/components/schemas/DiscrepanciesOutputParams"},"type":"array"},"inputTokens":{"type":"number"},"itemDetails":{"items":{"$ref":"#/components/schemas/SubmitItemDetailsToolCallParams"},"type":"array"},"modelName":{"type":"string"},"outputTokens":{"type":"number"},"overview":{"anyOf":[{"$ref":"#/components/schemas/SubmitOverviewToolCallParams"},{"nullable":true}]},"qaDetails":{"items":{"$ref":"#/components/schemas/SubmitQADetailsToolCallParams"},"type":"array"},"queryTimeMs":{"type":"number"},"totalCostUSD":{"type":"number"}},"required":["cachedTokens","discrepancies","inputTokens","itemDetails","modelName","outputTokens","overview","qaDetails","queryTimeMs","totalCostUSD"],"type":"object"},"AIInspectionCriteriaEvaluationResultV1":{"additionalProperties":false,"properties":{"cachedTokens":{"type":"number"},"discrepancies":{"items":{"$ref":"#/components/schemas/DiscrepanciesOutputParams"},"type":"array"},"inputTokens":{"type":"number"},"itemDetails":{"items":{"$ref":"#/components/schemas/SubmitItemDetailsToolCallParams"},"type":"array"},"modelResults":{"items":{"$ref":"#/components/schemas/AIInspectionCriteriaEvaluationModelResultV1"},"type":"array"},"outputTokens":{"type":"number"},"overview":{"anyOf":[{"$ref":"#/components/schemas/SubmitOverviewToolCallParams"},{"nullable":true}]},"qaDetails":{"items":{"$ref":"#/components/schemas/SubmitQADetailsToolCallParams"},"type":"array"},"queryTimeMs":{"type":"number"},"totalCostUSD":{"type":"number"}},"required":["cachedTokens","discrepancies","inputTokens","itemDetails","outputTokens","overview","qaDetails","queryTimeMs","totalCostUSD"],"type":"object"},"AIInspectionReadyCriteriaResultV1":{"additionalProperties":false,"properties":{"cachedTokens":{"type":"number"},"criteria":{"$ref":"#/components/schemas/CriteriaGenerationOutputV1"},"fromCache":{"type":"boolean"},"inputTokens":{"type":"number"},"outputTokens":{"type":"number"},"queryTimeMs":{"type":"number"},"totalCostUSD":{"type":"number"}},"required":["cachedTokens","criteria","fromCache","inputTokens","outputTokens","queryTimeMs","totalCostUSD"],"type":"object"},"AIInspectionReadyCriteriaResultV2":{"additionalProperties":false,"properties":{"cachedTokens":{"type":"number"},"criteria":{"$ref":"#/components/schemas/CriteriaGenerationOutputV2"},"fromCache":{"type":"boolean"},"inputTokens":{"type":"number"},"outputTokens":{"type":"number"},"queryTimeMs":{"type":"number"},"totalCostUSD":{"type":"number"}},"required":["cachedTokens","criteria","fromCache","inputTokens","outputTokens","queryTimeMs","totalCostUSD"],"type":"object"},"AIInspectionReadyResult":{"additionalProperties":false,"properties":{"client_override_date":{"type":"string","nullable":true},"client_override_result":{"anyOf":[{"$ref":"#/components/schemas/TestResult"},{"nullable":true}]},"client_override_user_id":{"type":"number","nullable":true},"details":{"anyOf":[{"$ref":"#/components/schemas/AIInspectionReadyResultDetailsV1"},{"$ref":"#/components/schemas/AIInspectionReadyResultDetailsV2"},{"nullable":true}]},"id":{"type":"number"},"initial_date":{"type":"string"},"initial_reason":{"type":"string","nullable":true},"initial_result":{"$ref":"#/components/schemas/TestResult"},"inspection_id":{"type":"number"}},"required":["id","inspection_id","details","initial_result","initial_reason","initial_date"],"type":"object"},"AIInspectionReadyResultDetailsV1":{"additionalProperties":false,"properties":{"criteria":{"anyOf":[{"$ref":"#/components/schemas/AIInspectionReadyCriteriaResultV1"},{"nullable":true}]},"criteriaEvaluation":{"anyOf":[{"items":{"$ref":"#/components/schemas/AIInspectionCriteriaEvaluationResultV1"},"type":"array"},{"nullable":true}]},"schema_version":{"type":"number"}},"required":["schema_version","criteria","criteriaEvaluation"],"type":"object"},"AIInspectionReadyResultDetailsV2":{"additionalProperties":false,"properties":{"criteria":{"anyOf":[{"$ref":"#/components/schemas/AIInspectionReadyCriteriaResultV2"},{"nullable":true}]},"criteriaEvaluation":{"anyOf":[{"items":{"$ref":"#/components/schemas/AIInspectionCriteriaEvaluationResultV1"},"type":"array"},{"nullable":true}]},"schema_version":{"type":"number"}},"required":["schema_version","criteria","criteriaEvaluation"],"type":"object"},"AIInspectionReadyResultQueryMetricsV1":{"additionalProperties":false,"properties":{"cachedTokens":{"type":"number"},"inputTokens":{"type":"number"},"outputTokens":{"type":"number"},"queryTimeMs":{"type":"number"},"totalCostUSD":{"type":"number"}},"required":["inputTokens","outputTokens","cachedTokens","totalCostUSD","queryTimeMs"],"type":"object"},"AIStatusDetails":{"additionalProperties":false,"description":"The details of the AI status for an inspection","properties":{"list_items":{"description":"AI analyses per-list-item","items":{"additionalProperties":false,"properties":{"list_item_id":{"description":"The id of the list item this AI analysis corresponds to","type":"number"},"status":{"$ref":"#/components/schemas/VerificationResult","description":"The AI's determination for this list item","example":"pass"},"status_reason":{"$ref":"#/components/schemas/AIStatusReason","description":"The reason for the AI's determination for this list item","example":"COMPLETE_WITH_NO_INCONSISTENCIES"},"summary":{"description":"A summary of the AI analysis for this list item, including any inconsistencies detected","type":"string"}},"required":["list_item_id"],"type":"object"},"type":"array"},"summary":{"description":"A summary of the overall AI analysis for the inspection","type":"string"}},"type":"object"},"AIStatusReason":{"enum":["COMPLETE_WITH_NO_INCONSISTENCIES","COMPLETE_WITH_INCONSISTENCIES","INCOMPLETE"],"type":"string"},"AIUserCriteriaResult":{"additionalProperties":false,"properties":{"client_override_date":{"type":"string","nullable":true},"client_override_result":{"type":"string","nullable":true},"client_override_user_id":{"type":"number","nullable":true},"details":{"anyOf":[{},{"nullable":true}]},"id":{"type":"number"},"initial_date":{"type":"string"},"initial_reason":{"type":"string","nullable":true},"initial_result":{"type":"string"},"inspection_id":{"type":"number"}},"required":["id","inspection_id","initial_result","initial_date"],"type":"object"},"AlertTrigger":{"additionalProperties":false,"properties":{"photo_id":{"type":"number"},"test_key":{"type":"string"}},"required":["test_key"],"type":"object"},"ChangeInspectionTypeBody":{"additionalProperties":false,"description":"The request body for PUT /inspections/{inspectionId}/inspection-type","properties":{"inspection_type_id":{"description":"The id of the inspection type this inspection is for.","example":12,"type":"number"}},"required":["inspection_type_id"],"type":"object"},"ContentAnalysisDetails":{"additionalProperties":false,"properties":{"expected":{"$ref":"#/components/schemas/ContentAnalysisExpectedValue","description":"The expected result of the content analysis test. Will be an object specifying a min and mix on the vehicle odometer for ODOMETER tests. Will be a string representing the expected VIN number on the vehicle for VIN tests. Will be a string representing the expected DOT TIN on the vehicle tire for DOT TIN tests.","example":"DG1FGA21D4TD173601"},"expected_required":{"description":"Whether or not an `expected` criteria needs to be entered at the time the inspection is sent.","example":true,"type":"boolean"},"type":{"$ref":"#/components/schemas/ContentAnalysisType","description":"The type of the content analysis test.","example":"VIN"}},"required":["type"],"type":"object"},"ContentAnalysisExpectedValue":{"anyOf":[{"type":"string"},{"nullable":true},{"$ref":"#/components/schemas/OdometerExpectedValue"},{"$ref":"#/components/schemas/TextMatchingExpectedValues"},{"$ref":"#/components/schemas/CustomFieldMatchingExpectedValues"}]},"ContentAnalysisResultDetails":{"additionalProperties":false,"properties":{"expected":{"$ref":"#/components/schemas/ContentAnalysisExpectedValue","description":"The expected result of the content analysis test. Will be an object specifying a min and mix on the vehicle odometer for ODOMETER tests. Will be a string representing the expected VIN number on the vehicle for VIN tests. Will be a string representing the expected DOT TIN on the vehicle tire for DOT TIN tests.","example":"DG1FGA21D4TD173601"},"expected_required":{"description":"Whether or not an `expected` criteria needs to be entered at the time the inspection is sent.","example":true,"type":"boolean"},"result":{"anyOf":[{"type":"number"},{"type":"string"},{"nullable":true},{"items":{"items":{"type":"string"},"type":"array"},"type":"array"},{"items":{"type":"string"},"type":"array"}],"description":"The result of the content analysis test. Will be a number representing the number on the vehicle odometer for ODOMETER tests. Will be a string representing the VIN number on the vehicle for VIN tests. Will be a string representing the DOT TIN on the vehicle tire for DOT TIN tests. Will be a 2D array of matched strings per each text matching set for TEXT_MATCHING tests. Will be an array of matched strings for CUSTOM_FIELD_MATCHING tests."},"type":{"$ref":"#/components/schemas/ContentAnalysisType","description":"The type of the content analysis test.","example":"VIN"}},"required":["result","type"],"type":"object"},"ContentAnalysisType":{"description":"The possible types of content analysis tests.","enum":["ODOMETER","VIN","TEXT_MATCHING","CUSTOM_FIELD_MATCHING","DOT_TIN"],"type":"string"},"CreateAIAnalysisSetProps":{"$ref":"#/components/schemas/AIAnalysisSetPayload"},"CreateAIAnalysisSetResult":{"$ref":"#/components/schemas/SuccessfulCreationResponseData"},"CreateAPICredentialsResult":{"additionalProperties":false,"description":"The response body for POST /auth/auth0","properties":{"api_version":{"description":"The current version number of the Vision API","example":"3.0.0","type":"string"},"client_id":{"description":"The client id for the organization's Vision API access.","type":"string"},"client_secret":{"description":"The client secret for the organization's Vision API access.","type":"string"},"created_at":{"description":"The date the API credentials and bot were created.","format":"datetime","type":"string"},"message":{"description":"The human readable-status of the response","example":"Success","type":"string"},"response_code":{"description":"The HTTP status code of the response","example":200,"type":"integer"}},"required":["api_version","client_id","client_secret","created_at","message","response_code"],"type":"object"},"CreateCustomFieldOptionSetProps":{"additionalProperties":false,"properties":{"name":{"description":"The name of the custom field option set","example":"Option Set Name","type":"string"},"options":{"description":"The available options in this option set","example":[{"name":"Option Label","value":"OPTION_ID"}],"items":{"additionalProperties":false,"properties":{"name":{"description":"The name of the option","type":"string"},"value":{"description":"The value of the option","example":"OPTION_ID","type":"string"}},"required":["value","name"],"type":"object"},"type":"array"}},"required":["name","options"],"type":"object"},"CreateInspectionBody":{"additionalProperties":false,"description":"Request Body for POST /inspections","properties":{"assigned_to_member_user":{"description":"The user to assign the inspection to. Can be either a user ID or an email address.","type":"string"},"copied_customer_info_was_edited":{"description":"Whether the customer info was edited relative to the copied inspection.","type":"boolean"},"copied_from_inspection_id":{"description":"The ID of the inspection this one was copied from, if applicable.","type":"number"},"copied_list_was_edited":{"description":"Whether the list was edited relative to the copied inspection.","type":"boolean"},"custom_field_values":{"description":"The values for the custom fields defined in the inspection type. The order of the values must match the order of the custom fields defined in the inspection type.  If the value is optional then you can provide null for that value.","example":["abc123","def123"],"items":{"type":"string"},"type":"array"},"customer_address":{"description":"The address where the inspection will be performed.","type":"string"},"customer_address_lat":{"description":"The latitude of the address where the inspection will be performed.","type":"string"},"customer_address_lng":{"description":"The longitude of the address where the inspection will be performed.","type":"string"},"customer_email_address":{"description":"The email address of the customer completing the inspection. Required if `send_methods.email` is `true`.","example":"kylorenxninja@gmail.com","format":"email","maxLength":255,"type":"string"},"customer_first_name":{"description":"The first name of the customer completing the inspection.","example":"Kylo","maxLength":255,"type":"string"},"customer_last_name":{"description":"The last name of the customer completing the inspection.","example":"Ren","maxLength":255,"type":"string"},"customer_name":{"description":"The full name of the customer who will be completing the inspection. If specified, then `customer_first_name` and `customer_last_name` will not be provided.","example":"Kylo Ren","maxLength":255,"type":"string"},"customer_phone_country":{"description":"The country code for the customer's phone number.","example":"US","maxLength":2,"type":"string"},"customer_phone_number":{"description":"The mobile number of the customer completing the inspection. Required if `send_methods.text` is `true`.","example":"3028675309","format":"phone","pattern":"/^[\\d]{10}$/","type":"string"},"include_list":true,"inspection_ready_criteria_text":{"description":"Free-form inspection-ready criteria text. Max length 10KB.","example":"Capture all rooms and appliances.","maxLength":10240,"type":"string","nullable":true},"inspection_type_id":{"description":"The id of the inspection type this inspection is for.","example":12,"type":"number"},"list":{"additionalProperties":false,"description":"Populate this object with list items to prompt the user for specific photos, videos, or questions during the inspection.","properties":{"groups":{"$ref":"#/components/schemas/ListItemGroups","description":"The groups of items in the list","example":{"grp1":{"name":"Group 2"}}},"items":{"description":"The list items describe prompts to the user for specific photos, videos, or questions during the inspection.","items":{"$ref":"#/components/schemas/ListItemPayload"},"type":"array"}},"required":["items"],"type":"object"},"message_supplement":{"description":"The message supplement (custom note) to be attached to the request text/email. Maximum length of 255 characters.","example":"Please complete in a timely manner","maxLength":255,"type":"string"},"scheduled_for":{"description":"The date/time (in UTC) the inspection is scheduled to be sent to the customer","example":"2020-05-01T21:44:40.000Z","format":"date-time","type":"string"},"scheduled_tz":{"description":"The IANA timezone name for the inspection's scheduled datetime. Used only for display purposes, as `scheduled_for` is in UTC.","example":"America/New_York","type":"string"},"send_methods":{"additionalProperties":false,"description":"The method(s) to send the inspection request to the customer completing the inspection.","properties":{"email":{"description":"When true, will send text messages to the customer_email_address","example":false,"type":"boolean"},"text":{"description":"When true, will send text messages to the customer_phone_number","example":true,"type":"boolean"}},"required":["text","email"],"type":"object"},"team_id":{"description":"The id of the team this inspection is for.","example":182,"type":"number"}},"type":"object"},"CreateInspectionResult":{"additionalProperties":false,"description":"Response body for POST /inspections","properties":{"api_version":{"description":"The current version number of the Vision API","example":"3.0.0","type":"string"},"message":{"description":"The human readable-status of the response","example":"Success","type":"string"},"response_code":{"description":"The HTTP status code of the response","example":200,"type":"integer"},"result":{"additionalProperties":false,"description":"An inspection object will all related data","properties":{"address":{"description":"The physical address where the inspection is expected to take place","example":"532 Mission Street, Santa Clara, CA, USA","format":"address","type":"string"},"address_lat":{"description":"The latitude of `address` if set, otherwise `null`.","example":"40.0612708","type":"string"},"address_lng":{"description":"The longitude of `address` if set, otherwise `null`.","example":"40.0612708","type":"string"},"ai_inspection_ready_result":{"anyOf":[{"$ref":"#/components/schemas/AIInspectionReadyResult"},{"nullable":true}]},"ai_status":{"$ref":"#/components/schemas/VerificationResult","description":"The AI analysis result for this inspection.","example":"pass"},"ai_status_details":{"$ref":"#/components/schemas/AIStatusDetails","description":"The details of the AI status for this inspection. This may include information about the criteria evaluation, any inconsistencies detected, and more."},"ai_status_reason":{"$ref":"#/components/schemas/AIStatusReason","description":"The reason for the AI analysis result for this inspection.","example":"COMPLETE_WITH_NO_INCONSISTENCIES"},"ai_user_criteria_result":{"anyOf":[{"$ref":"#/components/schemas/AIUserCriteriaResult"},{"nullable":true}]},"alert":{"$ref":"#/components/schemas/InspectionAlertResult"},"app_opened":true,"assigned_to_member_user":{"$ref":"#/components/schemas/User"},"assigned_to_member_user_id":{"description":"The id of the user this inspection is assigned to.","example":19,"type":"number"},"created_at":{"description":"The date/time the resource was created","example":"2020-05-01T21:44:40.000Z","format":"date-time","type":"string"},"created_by_member_user":{"$ref":"#/components/schemas/User"},"created_by_member_user_id":{"description":"The id of the member that created this inspection.","example":43,"type":"number"},"custom_field_values":{"description":"The values for the custom fields defined in the inspection type. The order of the values must match the order of the custom fields defined in the inspection type.  If the value is optional then you can provide null for that value.","example":["abc123","def123"],"items":{"type":"string"},"type":"array"},"customer_email_address":{"description":"The email address of the customer completing the inspection. Required if `send_methods.email` is `true`.","example":"kylorenxninja@gmail.com","format":"email","maxLength":255,"type":"string"},"customer_first_name":{"description":"The first name of the customer completing the inspection.","example":"Kylo","maxLength":255,"type":"string"},"customer_ip_address":{"description":"The IP address of the customer, recorded during the most recent photo capture inspection.","example":"123.532.124.174","format":"ipv4, ipv6","maxLength":255,"type":"string"},"customer_last_name":{"description":"The last name of the customer completing the inspection.","example":"Ren","maxLength":255,"type":"string"},"customer_name":{"description":"The full name of the customer who will be completing the inspection. If specified, then `customer_first_name` and `customer_last_name` will not be provided.","example":"Kylo Ren","maxLength":255,"type":"string"},"customer_phone_country":{"description":"The country code for the customer's phone number.","example":"US","maxLength":2,"type":"string"},"customer_phone_number":{"description":"The mobile number of the customer completing the inspection. Required if `send_methods.text` is `true`.","example":"3028675309","format":"phone","pattern":"/^[\\d]{10}$/","type":"string"},"deleted_at":{"description":"The date/time the inspection was deleted. `null` if not deleted.","example":"2020-05-01T21:44:40.000Z","format":"date-time","type":"string","nullable":true},"deleted_by_user_id":{"description":"The ID of the user who deleted the inspection. `null` if not deleted or auto-deleted by the system.","example":19,"type":"number","nullable":true},"devices":{"items":{"$ref":"#/components/schemas/InspectionDeviceInfo"},"type":"array"},"email_auto_reply_sent":{"description":"The datetime an email automated reply was sent","example":"2023-01-04 15:11:39.642","format":"date-time","type":"string"},"group":{"$ref":"#/components/schemas/Group"},"group_id":{"description":"The id of the group this inspection is for.","example":23,"type":"number"},"has_survey_available":{"type":"boolean"},"id":{"description":"The id of the inspection request","example":1843,"type":"number"},"insights":{"items":{"additionalProperties":false,"properties":{"type":{"$ref":"#/components/schemas/InspectionInsightType"}},"required":["type"],"type":"object"},"type":"array"},"inspection_link":{"description":"A smart link to load the inspection in the Vision app. This link is generated by the Vision backend and is unique to the inspection.","example":"visionbytruepic.com/23AUkqg1xRb","type":"string"},"inspection_ready_criteria_text":{"description":"Free-form inspection-ready criteria text. Max length 10KB.","example":"Capture all rooms and appliances.","maxLength":10240,"type":"string","nullable":true},"inspection_status_id":{"$ref":"#/components/schemas/InspectionStatusId","description":"The id of the inspection status this inspection is in.","example":4},"inspection_type":{"additionalProperties":false,"description":"An inspection type with attached list and message template set data","properties":{"created_at":{"description":"The date/time the resource was created","example":"2020-05-01T21:44:40.000Z","format":"date-time","type":"string"},"created_by_member_user_id":{"description":"the id of the user who created this inspection type. References `users.id`","example":2343,"type":"number"},"custom_fields":{"description":"The custom fields associated with this Inspection Type with any custom field values","items":{"$ref":"#/components/schemas/PopulatedCustomField"},"type":"array"},"customer_unique_id_2":{"$ref":"#/components/schemas/UniqueID2","deprecated":true,"description":"The details about customer unique id 2. This field still works in v2 but for v3 you must use `custom_fields` instead.","example":{"entry_method":"ENTRY_METHOD_TEXT","is_enabled":true,"is_required":false,"label":"Custom ID 2"}},"customer_unique_id_label":{"deprecated":true,"description":"The entry method for the customer unique id field. This field still works in v2 but for v3 you must use `custom_fields` instead.","example":"Custom ID","type":"string"},"entry_method":{"$ref":"#/components/schemas/CustomFieldEntryMethods","deprecated":true,"description":"The label for the customer unique id field. This field still works in v2 but for v3 you must use `custom_fields` instead."},"id":{"description":"The id of the inspection type","example":1843,"type":"number"},"inspection_alert_config":{"$ref":"#/components/schemas/InspectionAlertConfig","description":"The alert configuration that is used by this inspection type."},"inspection_alert_config_id":{"description":"The id of the inspection alert configuration that is used by this inspection type. References `inspection_alert_configs.id`","example":539,"type":"number"},"inspection_ready_criteria_text":{"description":"Optional inspection-ready criteria text for this inspection type.","example":"Capture the VIN plate clearly and include a full odometer photo.","type":"string","nullable":true},"is_address_required":{"description":"Controls whether an address is required for the inspection or not","example":1000,"type":"boolean"},"is_deleted":true,"is_list_locked":{"description":"When true, the list associated with this inspection type cannot be changed","example":false,"type":"boolean"},"language":{"$ref":"#/components/schemas/LocalizationLanguages","description":"The IETF language tag for the intended language of the inspection. Non-customizable text in emails will use the language specified here."},"list":{"additionalProperties":false,"description":"The list associated with this Inspection Type","properties":{"created_at":{"description":"The date/time the resource was created","example":"2020-05-01T21:44:40.000Z","format":"date-time","type":"string"},"created_by_member_user_id":{"description":"The id of the user that created this list","example":609,"type":"number"},"groups":{"$ref":"#/components/schemas/ListItemGroups","description":"The groups of items in the list","example":{"grp1":{"name":"Group 2"}}},"id":{"description":"The id of the resource.","example":1843,"type":"number"},"inspection_id":{"description":"The id of the inspection that this list belongs to","example":6342,"type":"number"},"inspection_types":{"items":{"$ref":"#/components/schemas/InspectionType"},"type":"array"},"is_deleted":true,"items":{"items":{"$ref":"#/components/schemas/ListItem"},"type":"array"},"name":{"description":"The auto-generated name of the list.","example":"List for Inspection 3527","type":"string"},"organization_id":{"description":"The id of the organization that this list belongs to","example":52,"type":"number"},"team_id":{"description":"The id of the team that this list belongs to","example":66,"type":"number"},"type":{"$ref":"#/components/schemas/ListType","description":"The type of the list. Must be `EVENT_TEMPLATE`, `EVENT_INSTANCE`, `SURVEY_TEMPLATE`, or `SURVEY_INSTANCE`","example":"EVENT_TEMPLATE"},"updated_at":{"description":"The date/time the resource was last updated","example":"2020-05-01T21:44:40.000Z","format":"date-time","type":"string"}},"required":["created_at","id","inspection_types","is_deleted","items","name","organization_id","type","updated_at"],"type":"object"},"list_id":{"description":"The id of the list that is used by this inspection type. References `lists.id`","example":3345,"type":"number"},"max_distance_from_address_threshold":{"description":"the maximum distance away from the configured inspection address that an inspection can be completed in meters.","example":1000,"type":"number"},"message_template_set":{"$ref":"#/components/schemas/MessageTemplateSet","description":"The message template set associated with this Inspection Type"},"message_template_set_id":{"description":"The id of the message template set that is used by this inspection type. References `message_template_sets.id`","example":539,"type":"number"},"modified_by_member_user_id":{"description":"the id of the user who last modified this inspection type. References `users.id`","example":2343,"type":"number"},"name":{"description":"The name of the inspection type","example":"My Type","type":"string"},"organization_id":{"description":"the id of the organization that this inspection type belongs to. References `organizations.id`.","example":14,"type":"number"},"outcome_set":{"$ref":"#/components/schemas/OutcomeSet","description":"The outcome set that is used by this inspection type."},"outcome_set_id":{"description":"The id of the outcome set that is used by this inspection type. References `outcome_sets.id`","example":539,"type":"number"},"team_id":{"deprecated":true,"description":"the id of the team that this inspection type belongs to. References `teams.id`. Note that this is no longer used, and inspection types can now be associated with multiple teams","example":124,"type":"number"},"teams":{"description":"The the teams that use this inspection type.","items":{"additionalProperties":false,"properties":{"id":{"description":"The id of the resource","example":1843,"type":"number"},"name":{"description":"The name of the team.","example":"Claims","type":"string"}},"required":["id"],"type":"object"},"type":"array"},"updated_at":{"description":"The date/time the resource was last updated","example":"2020-05-01T21:44:40.000Z","format":"date-time","type":"string"},"use_single_name_field":{"description":"When true, there is only one name for the user to fill out rather than a separate first name and last name field","example":true,"type":"boolean"}},"required":["created_at","custom_fields","id","is_address_required","is_deleted","is_list_locked","language","list","message_template_set","message_template_set_id","name","organization_id","team_id","updated_at","use_single_name_field"],"type":"object"},"inspection_type_id":{"description":"The id of the inspection type this inspection is for.","example":12,"type":"number"},"is_deleted":true,"is_expired":true,"list":{"additionalProperties":false,"properties":{"groups":{"$ref":"#/components/schemas/ListItemGroups","description":"The groups of items in the list","example":{"grp1":{"name":"Group 2"}}},"id":{"description":"The id of the resource.","example":1843,"type":"number"},"items":{"items":{"$ref":"#/components/schemas/InspectionListItemWithPhotos"},"type":"array"},"name":{"description":"The auto-generated name of the list.","example":"List for Inspection 3527","type":"string"}},"required":["id","items","name"],"type":"object"},"locations":{"items":{"$ref":"#/components/schemas/PopulatedLocation"},"type":"array"},"max_distance_from_address_threshold":{"description":"The maximum distance, in meters, from the address that the photos/videos must be taken in order to be valid","example":1000,"type":"integer"},"message_supplement":{"description":"The message supplement (custom note) to be attached to the request text/email. Maximum length of 255 characters.","example":"Please complete in a timely manner","maxLength":255,"type":"string"},"organization":{"$ref":"#/components/schemas/Organization"},"organization_enabled_features":{"items":{"$ref":"#/components/schemas/OrganizationEnabledFeature"},"type":"array"},"organization_id":{"description":"The id of the organization this inspection is for.","example":117,"type":"number"},"organization_team":{"$ref":"#/components/schemas/Team"},"outcome":{"$ref":"#/components/schemas/Outcome"},"outcome_id":{"description":"The id of the outcome of this inspection.","example":29,"type":"number"},"outcome_reason":{"description":"The reason for the outcome of this inspection","example":"Customer cancelled their service with our company","type":"string"},"photo_counts":{},"photo_uploaded_at":{"description":"The date/time when the last photo/video was uploaded. ISO 8601 format.","example":"2020-05-01T21:44:40.000Z","format":"date-time","type":"string"},"photos":{"items":{"$ref":"#/components/schemas/InspectionTruepic"},"type":"array"},"platform":{"$ref":"#/components/schemas/InspectionPlatform","description":"The platform of our app that the inspection will be / has been performed on."},"scheduled_for":{"description":"The date/time (in UTC) the inspection is scheduled to be sent to the customer","example":"2020-05-01T21:44:40.000Z","format":"date-time","type":"string"},"scheduled_tz":{"description":"The IANA timezone name for the inspection's scheduled datetime. Used only for display purposes, as `scheduled_for` is in UTC.","example":"America/New_York","type":"string"},"send_methods":{"additionalProperties":false,"description":"The method(s) to send the inspection request to the customer completing the inspection.","properties":{"email":{"description":"When true, will send text messages to the customer_email_address","example":false,"type":"boolean"},"text":{"description":"When true, will send text messages to the customer_phone_number","example":true,"type":"boolean"}},"required":["text","email"],"type":"object"},"sent_auto_finish_reminders":{"description":"Times to send automated finish reminders","example":["10m","20m","30m"],"items":{"type":"string"},"type":"array"},"sent_auto_reminders":{"description":"Times to send automated reminders","example":["10m","20m","30m"],"items":{"type":"string"},"type":"array"},"sms_auto_reply_sent":{"description":"The datetime an sms automated reply was sent","example":"2023-01-04 15:11:39.642","format":"date-time","type":"string"},"status":{"$ref":"#/components/schemas/InspectionStatus"},"team_id":{"description":"The id of the team this inspection is for.","example":182,"type":"number"},"timeline":{"items":{"additionalProperties":false,"description":"A TimeLineAction with the action type and location populated","properties":{"action_type":{"$ref":"#/components/schemas/TimelineActionType"},"created_at":{"description":"The date/time the resource was created","example":"2020-05-01T21:44:40.000Z","format":"date-time","type":"string"},"customer_user_id":{"description":"The id of the app user that performed this action","example":4335,"type":"number"},"data":{"additionalProperties":false,"description":"An object containing any additional data related to the action.","properties":{"flags":{"additionalProperties":false,"description":"The flags and comment applied for the ACTION_DEVICE_FLAGS_CHANGED activity","properties":{"comment":{"description":"The comment to apply to the activity log for this flag action.","type":"string"},"flags":{"description":"The complete list of flags to apply to the device for this inspection. This will update the list of flags to match this array by adding and/or removing any existing flags.","items":{"$ref":"#/components/schemas/DeviceFlagType"},"type":"array"}},"required":["flags"],"type":"object"},"is_details_full_message":{"description":"Whether the full message was sent","example":true,"type":"boolean"},"list_item_id":{"description":"The id of the associated list item","example":12345,"type":"number"},"location":{"$ref":"#/components/schemas/LensActivityLocationData","description":"An optional location associated with the action"},"message_id":{"description":"The Sendgrid email message id of the associated message","example":"DGnO3FNol23452ewf9v-7786453638cc-xx435l-1-646B123C-53.0","type":"string"},"reason":{"description":"If the action was triggered by a Lens activity, this will contain details about the activity","example":"timestamp_old","type":"string"},"tags":{"description":"An array of tag strings describing an activity","items":{"type":"string"},"type":"array"},"truepic_id":{"description":"The id of the associated Truepic","example":12345,"type":"number"}},"type":"object"},"details":{"description":"Any additional information, such as a member's custom message or more descriptive text.","type":"number","nullable":true},"device_fingerprint_details_request_id":{"description":"The id of the device fingerprint record","type":"string"},"device_id":{"description":"The id of the device record","example":1843,"type":"number"},"device_validation_status":{"$ref":"#/components/schemas/DeviceValidationStatus","description":"The determined status of the fingerprint data.","example":"VALID"},"id":{"description":"The id of the resource.","example":1843,"type":"number"},"inspection_id":{"description":"The id of the inspection this action occurred on","example":4335,"type":"number"},"is_deleted":true,"location":{"$ref":"#/components/schemas/PopulatedLocation"},"location_id":{"description":"The id of the location record","example":12345,"type":"number"},"member_user_id":{"description":"The id of the dashboard user that performed this action","example":4335,"type":"number"},"meta":{"description":"Any meta information, such as the URL when a new smart link is generated.","type":"string"},"timeline_action_type_id":{"description":"The id of the action type","example":12,"type":"number"},"updated_at":{"description":"The date/time the resource was last updated","example":"2020-05-01T21:44:40.000Z","format":"date-time","type":"string"}},"required":["action_type","created_at","id","inspection_id","location","updated_at"],"type":"object"},"type":"array"},"updated_at":{"description":"The date/time the resource was last updated","example":"2020-05-01T21:44:40.000Z","format":"date-time","type":"string"},"verification_result":{"$ref":"#/components/schemas/VerificationResult","description":"The aggregate verification result of all photos/videos","example":"pass"},"organization_token_status":{"additionalProperties":false,"properties":{"expires":{"type":"number","nullable":true},"is_valid":{"type":"boolean"}},"required":["is_valid"],"type":"object"}},"required":["alert","app_opened","assigned_to_member_user","assigned_to_member_user_id","created_at","created_by_member_user","created_by_member_user_id","custom_field_values","organization_token_status","devices","has_survey_available","id","insights","inspection_status_id","inspection_type","inspection_type_id","is_deleted","is_expired","list","locations","organization","organization_enabled_features","organization_id","organization_team","photo_counts","photos","send_methods","status","team_id","timeline","updated_at"],"type":"object"}},"required":["api_version","message","response_code","result"],"type":"object"},"CreateInspectionTypeBody":{"additionalProperties":false,"description":"Request Body for POST /inspections","properties":{"created_by_member_user_id":{"description":"the id of the user who created this inspection type. References `users.id`","example":2343,"type":"number"},"custom_fields":{"description":"An array of custom fields that are used by this inspection type","items":{"$ref":"#/components/schemas/CustomField"},"type":"array"},"inspection_alert_config_id":{"description":"The id of the inspection alert configuration that is used by this inspection type. References `inspection_alert_configs.id`","example":539,"type":"number"},"inspection_ready_criteria_text":{"description":"Optional inspection-ready criteria text for this inspection type.","example":"Capture the VIN plate clearly and include a full odometer photo.","type":"string","nullable":true},"is_address_required":{"description":"Controls whether an address is required for the inspection or not","example":1000,"type":"boolean"},"is_list_locked":{"description":"When true, the list associated with this inspection type cannot be changed","example":false,"type":"boolean"},"language":{"$ref":"#/components/schemas/LocalizationLanguages","description":"The IETF language tag for the intended language of the inspection. Non-customizable text in emails will use the language specified here."},"list_id":{"description":"The id of the list that is used by this inspection type. References `lists.id`","example":3345,"type":"number"},"max_distance_from_address_threshold":{"description":"the maximum distance away from the configured inspection address that an inspection can be completed in meters.","example":1000,"type":"number"},"message_template_set_id":{"description":"The id of the message template set that is used by this inspection type. References `message_template_sets.id`","example":539,"type":"number"},"modified_by_member_user_id":{"description":"the id of the user who last modified this inspection type. References `users.id`","example":2343,"type":"number"},"name":{"description":"The name of the inspection type","example":"My Type","type":"string"},"outcome_set_id":{"description":"The id of the outcome set that is used by this inspection type. References `outcome_sets.id`","example":539,"type":"number"},"use_single_name_field":{"description":"When true, there is only one name for the user to fill out rather than a separate first name and last name field","example":true,"type":"boolean"}},"required":["name","is_list_locked","message_template_set_id","is_address_required","use_single_name_field","custom_fields","language"],"type":"object"},"CreateInternalNoteBody":{"additionalProperties":false,"description":"The request body for POST /inspections/{inspectionId}/internal-note","properties":{"note":{"description":"The note to add to the inspection.","type":"string"}},"required":["note"],"type":"object"},"CreateLandingPageBody":{"additionalProperties":false,"properties":{"inspection_type_ids":{"description":"The IDs of the inspection types that can be created from the landing page.","example":[123,456],"items":{"type":"number"},"type":"array"},"name":{"description":"The name of the landing page.","example":"Landing Page","type":"string"},"page_body":{"description":"The body of the landing page.","example":"Fill out the form below to get started...","type":"string"},"page_title":{"description":"The title of the landing page.","example":"Start your application today!","type":"string"},"team_id":{"description":"The ID of the team that the landing page belongs to.","example":789,"type":"number"}},"required":["inspection_type_ids","name","page_body","page_title","team_id"],"type":"object"},"CreateListBody":{"$ref":"#/components/schemas/CreateListPayload","description":"Request Body for POST /inspections"},"CreateListPayload":{"additionalProperties":false,"properties":{"groups":{"$ref":"#/components/schemas/ListItemGroups","description":"The groups of items in the list","example":{"grp1":{"name":"Group 2"}}},"items":{"description":"The list items describe prompts to the user for specific photos, videos, or questions during the inspection.","items":{"$ref":"#/components/schemas/ListItemPayload"},"type":"array"},"name":{"description":"The auto-generated name of the list.","example":"List for Inspection 3527","type":"string"}},"required":["items","name"],"type":"object"},"CreateMessageTemplateSetBody":{"additionalProperties":false,"description":"Request Body for POST /inspections","properties":{"auto_reply":{"description":"The message template for messages sent as automated replies when an app user sends a message to a member/dashboard-user.","type":"string"},"finish_reminder":{"description":"The message template for messages sent as reminders for started, but unfinished inspection requests.","example":"Hi {{OrganizationFirstName}}, this is {{MemberName}} from {{CompanyName}} reminding you that you have until {{ExpirationDueDateTime}} to finish your inspection. Please tap the following link to open the Truepic Vision app and return to your inspection: {{SmartLink}} {{CustomNote}} Thank you, and please call us at {{ClientSupportNumber}} with any questions.","type":"string"},"finish_reminder_subject":{"description":"The message template for messages sent as reminders to finish inspections.","example":"Reminder to finish inspection for {{OrganizationFirstName}}","type":"string"},"inspection_finished":{"description":"The message template for messages sent for finished inspection requests.","example":"Hi {{OrganizationFirstName}}. Your inspection has been completed and we will reach out with a result shortly. Thank you, and please call us at {{ClientSupportNumber}} with any questions.","type":"string"},"inspection_finished_enabled":{"default":false,"description":"Whether or not the \"inspection finished\" message is enabled and will be sent.","example":false,"type":"boolean"},"inspection_finished_subject":{"description":"The email subject for messages sent for finished inspection requests.","example":"Inspection Finished for {{OrganizationFirstName}}","type":"string"},"name":{"description":"The name of the message template set","example":"Default Set","maxLength":255,"type":"string"},"new_request":{"description":"The message template for messages sent for new inspection requests.","example":"Hi {{OrganizationFirstName}}, this is {{MemberName}} reaching out to request photos. To begin, click on the following link to download the Truepic Vision app: {{SmartLink}} Follow the onscreen instructions to capture photos. Please note, this request will expire on {{ExpirationDueDateTime}}. {{CustomNote}} Thank you, and please contact us with any questions.","type":"string"},"new_request_subject":{"description":"The email subject for messages sent for new inspection requests.","example":"New Inspection for {{OrganizationFirstName}}","type":"string"},"request_more":{"description":"The message template for messages sent to request additional items on an inspection request.","example":"Hi {{OrganizationFirstName}}, this is {{MemberName}} requesting that you upload additional photos. To begin, click on the following link to download the Truepic Vision app: {{SmartLink}} Follow the onscreen instructions to capture photos. Please note, this request will expire on {{ExpirationDueDateTime}}. {{CustomNote}} Thank you, and please contact us with any questions.","type":"string"},"request_more_subject":{"description":"The message template for messages sent as requests for more photos on inspections.","example":"More Photos Requested for {{OrganizationFirstName}}","type":"string"},"request_reminder":{"description":"The message template for messages sent as reminders for pending inspection requests.","example":"Hi {{OrganizationFirstName}}, this is {{MemberName}} sending a reminder that you have not yet submitted the requested photos. To begin, click on the following link to download the Truepic Vision app: {{SmartLink}} Follow the onscreen instructions to capture photos. Please note, this request will expire on {{ExpirationDueDateTime}}. {{CustomNote}} Thank you, and please contact us with any questions.","type":"string"},"request_reminder_subject":{"description":"The email subject for messages sent as reminders for non-started inspections.","example":"Inspection Reminder for {{OrganizationFirstName}}","type":"string"}},"required":["name","new_request","request_reminder","request_more","auto_reply","inspection_finished","inspection_finished_enabled","inspection_finished_subject","new_request_subject","request_reminder_subject","request_more_subject","finish_reminder_subject"],"type":"object"},"CreateTeamParams":{"additionalProperties":false,"properties":{"copy_inspection_type_assignments":{"description":"Whether to copy inspection type assignments from the template team, you must also provide a template_team_id","example":true,"type":"boolean"},"copy_user_assignments":{"description":"Whether to copy user assignments from the template team, you must also provide a template_team_id","example":true,"type":"boolean"},"name":{"description":"The name of the team.","example":"Claims","type":"string"},"template_team_id":{"description":"The ID of the team you want to use as a template for this new team","example":1843,"type":"number"}},"type":"object"},"CreateTextMatchingSetProps":{"additionalProperties":false,"properties":{"name":{"description":"The name of the text matching set","example":"Text Matching Set Name","type":"string"},"strings":{"description":"The available options in this text matching set","example":["String 1","String 2","String 3"],"items":{"type":"string"},"type":"array"},"type":{"description":"The type of text matching set","example":"Serial Number","type":"string"}},"required":["name","strings","type"],"type":"object"},"CreateUserBody":{"additionalProperties":false,"description":"The request body for POST /users","properties":{"email":{"description":"The email address of the user.","example":"kylorenxninja@potato.com","format":"email","type":"string"},"first_name":{"description":"The first name of the user.","example":"Kylo","type":"string"},"last_name":{"description":"The last name of the user.","example":"Ren","type":"string"},"role":{"$ref":"#/components/schemas/UserCreateRole","description":"A role to assign to the user. This will dictate what permissions the user has in the Vision system."},"teams":{"description":"A list of team IDs. This will update the teams that the user is assigned to.","items":{"type":"number"},"type":"array"}},"required":["email","first_name","last_name","role","teams"],"type":"object"},"CreateUserResult":{"additionalProperties":false,"description":"The response body for POST /users","properties":{"api_version":{"description":"The current version number of the Vision API","example":"3.0.0","type":"string"},"message":{"description":"The human readable-status of the response","example":"Success","type":"string"},"response_code":{"description":"The HTTP status code of the response","example":200,"type":"integer"},"result":{"additionalProperties":false,"properties":{"id":{"description":"The id of the user","example":1843,"type":"number"},"message":{"description":"The status of the update request","type":"string"}},"required":["id","message"],"type":"object"}},"required":["api_version","message","response_code","result"],"type":"object"},"CreateWebsiteFormBearerInspectionBody":{"additionalProperties":false,"properties":{"address_place_id":{"type":"string"},"address_session_token":{"type":"string"},"custom_fields":{"items":{"type":"string"},"type":"array"},"email":{"type":"string"},"first_name":{"type":"string"},"inspection_type_id":{"type":"string"},"last_name":{"type":"string"},"name":{"type":"string"},"phone":{"type":"string"}},"required":["custom_fields"],"type":"object"},"CreateWebsiteFormBearerInspectionResult":{"additionalProperties":false,"properties":{"api_version":{"description":"The current version number of the Vision API","example":"3.0.0","type":"string"},"message":{"description":"The human readable-status of the response","example":"Success","type":"string"},"response_code":{"description":"The HTTP status code of the response","example":200,"type":"integer"},"result":{"$ref":"#/components/schemas/WebsiteFormInspectionSerialized"}},"required":["api_version","message","response_code","result"],"type":"object"},"CreateWebsiteFormBody":{"additionalProperties":false,"properties":{"allowed_origins":{"description":"The domains that the website form is allowed to be embedded on. URLs must include `https://` and cannot include a path. An asterisk (*) can be used in place of the subdomain to allow any subdomain.","example":["https://website1.com","https://subdomain.website1.com","https://*.website2.com"],"items":{"type":"string"},"type":"array"},"inspection_type_ids":{"description":"The IDs of the inspection types that can be created from the website form.","example":[123,456],"items":{"type":"number"},"type":"array"},"is_email_required":{"description":"Whether the email field is required on the website form. Defaults to `false`.","example":false,"type":"boolean"},"is_phone_required":{"description":"Whether the phone field is required on the website form. Defaults to `false`.","example":false,"type":"boolean"},"name":{"description":"The name of the website form.","example":"Landing Page","type":"string"},"should_show_address":{"description":"Whether the address field should be shown on the website form when it is optional. The field is always shown if it is required by the inspection type. Defaults to `false`.","example":false,"type":"boolean"},"team_id":{"description":"The ID of the team that the website form creates inspections within.","example":789,"type":"number"}},"required":["allowed_origins","inspection_type_ids","name","team_id"],"type":"object"},"CriteriaEvaluationOutput":{"additionalProperties":false,"properties":{"discrepancies":{"items":{"$ref":"#/components/schemas/DiscrepanciesOutputParams"},"type":"array"},"itemDetails":{"items":{"$ref":"#/components/schemas/SubmitItemDetailsToolCallParams"},"type":"array"},"overview":{"anyOf":[{"$ref":"#/components/schemas/SubmitOverviewToolCallParams"},{"nullable":true}]},"qaDetails":{"items":{"$ref":"#/components/schemas/SubmitQADetailsToolCallParams"},"type":"array"}},"required":["overview","itemDetails","qaDetails","discrepancies"],"type":"object"},"CriteriaGenerationOutput":{"items":{"additionalProperties":false,"properties":{"criteria":{"items":{"additionalProperties":false,"properties":{"criterion":{"type":"string"},"criterion_id":{"type":"number"}},"required":["criterion","criterion_id"],"type":"object"},"type":"array"},"instructions":{"type":"string"},"sufficient_sets":{"items":{"items":{"type":"number"},"type":"array"},"type":"array"}},"required":["criteria","instructions","sufficient_sets"],"type":"object"},"type":"array"},"CriteriaGenerationOutputV1":{"additionalProperties":false,"properties":{"output":{"$ref":"#/components/schemas/CriteriaGenerationOutput"},"schemaVersion":{"type":"number"}},"required":["schemaVersion","output"],"type":"object"},"CriteriaGenerationOutputV2":{"additionalProperties":false,"properties":{"output":{"items":{"$ref":"#/components/schemas/CriteriaGenerationToolCallParams"},"type":"array"},"schemaVersion":{"type":"number"}},"required":["schemaVersion","output"],"type":"object"},"CriteriaGenerationToolCallParams":{"additionalProperties":false,"properties":{"criteria":{"items":{"additionalProperties":false,"properties":{"criterion":{"type":"string"},"criterion_id":{"type":"number"}},"required":["criterion","criterion_id"],"type":"object"},"type":"array"},"list_id":{"type":"number"},"sufficient_sets":{"items":{"items":{"type":"number"},"type":"array"},"type":"array"}},"required":["list_id","criteria","sufficient_sets"],"type":"object"},"CustomField":{"additionalProperties":false,"properties":{"custom_field_option_set_id":{"description":"The id of the custom field option set used by this custom field when the entry method is ENTRY_METHOD_SELECTABLE","type":"number"},"entry_method":{"$ref":"#/components/schemas/CustomFieldEntryMethods","description":"The entry method for the custom field"},"is_required":true,"label":{"description":"The label for the custom field","type":"string"}},"required":["entry_method","is_required"],"type":"object"},"CustomFieldEntryMethods":{"enum":["ENTRY_METHOD_TEXT","ENTRY_METHOD_VIN","ENTRY_METHOD_SELECTABLE"],"type":"string"},"CustomFieldMatchingExpectedValues":{"items":{"additionalProperties":false,"properties":{"custom_field_index":{"description":"The index of the custom field to match against.","example":1,"type":"number"},"inspection_type_id":{"description":"The id of the inspection type the custom field belongs to. If not provided, will default to the inspection's inspection type.","example":5124,"type":"number"}},"required":["custom_field_index","inspection_type_id"],"type":"object"},"type":"array"},"CustomFieldOption":{"additionalProperties":false,"properties":{"label":{"description":"The label for the custom field option","example":"My Custom Field Option","type":"string"},"value":{"description":"The value for the custom field option","example":"OPTION_VALUE","type":"string"}},"required":["label","value"],"type":"object"},"CustomFieldOptionSet":{"additionalProperties":false,"description":"A set of possible options that a user can select from when creating an inspection","properties":{"created_at":{"description":"The date/time the resource was created","example":"2020-05-01T21:44:40.000Z","format":"date-time","type":"string"},"created_by_user_id":{"description":"The id of the user that created this option custom field option set.","example":894,"type":"number"},"id":{"description":"The id of the resource.","example":1843,"type":"number"},"is_deleted":true,"modified_by_user_id":{"description":"The id of the user that last edited this custom field option set.","example":542,"type":"number"},"name":{"description":"The name of the custom field option set","example":"Option Set Name","type":"string"},"options":{"description":"The available options in this option set","example":[{"name":"Option Label","value":"OPTION_ID"}],"items":{"additionalProperties":false,"properties":{"name":{"description":"The name of the option","type":"string"},"value":{"description":"The value of the option","example":"OPTION_ID","type":"string"}},"required":["value","name"],"type":"object"},"type":"array"},"organization_id":{"description":"The id of the organization that owns this custom field option set.","example":532,"type":"number"},"updated_at":{"description":"The date/time the resource was last updated","example":"2020-05-01T21:44:40.000Z","format":"date-time","type":"string"}},"required":["created_at","created_by_user_id","id","is_deleted","name","options","organization_id","updated_at"],"type":"object"},"DeleteLandingPageResult":{"$ref":"#/components/schemas/ResponseData"},"DeleteWebsiteFormResult":{"$ref":"#/components/schemas/ResponseData"},"DetailsReadinessStatus":{"enum":["READY","UNUSABLE","WRONG_CONTEXT"],"type":"string"},"Device":{"additionalProperties":false,"description":"A device record that contains information about the device used to take a photo or perform another action in an inspection.","properties":{"created_at":{"description":"The date/time the resource was created","example":"2020-05-01T21:44:40.000Z","format":"date-time","type":"string"},"device":{"description":"The device model, as returned by the device fingerprinting service.","example":"iPhone 12","type":"string"},"fingerprint_id":{"description":"The Fingerprint ID of the device, as returned by the device fingerprinting service.","example":"Y7k0XNpijpaOjbQ0Yyzq","type":"string"},"id":{"description":"The id of the device record.","example":1843,"type":"number"},"last_seen_at":{"description":"The date and time when the device was last seen by the system.","example":"2023-10-01T12:00:00Z","type":"string"},"os":{"description":"The operating system of the device, as returned by the device fingerprinting service.","example":"iOS","type":"string"},"os_version":{"description":"The version of the operating system of the device, as returned by the device fingerprinting service.","example":"14.4","type":"string"},"updated_at":{"description":"The date/time the resource was last updated","example":"2020-05-01T21:44:40.000Z","format":"date-time","type":"string"}},"required":["created_at","device","fingerprint_id","id","last_seen_at","os","os_version","updated_at"],"type":"object"},"DeviceFlagType":{"enum":["rooted_device","spoofed_location","falsified_time","incorrect_location","picture_of_photo","bad_photo","deleted_photos","bad_answer","other"],"type":"string"},"DeviceValidationStatus":{"enum":["VALID","REQUEST_ID_MISMATCH","REQUEST_ID_MISSING","FETCH_FROM_FINGERPRINT_FAILED","TIMESTAMP_TOO_FAR_IN_PAST","TIMESTAMP_TOO_FAR_IN_FUTURE","TIMESTAMP_MISSING","TIMESTAMP_INVALID","NO_FINGERPRINT_DATA","INVALID_FINGERPRINT_DATA","DECRYPT_FINGERPRINT_FAIL","FINGERPRINT_CONFIDENCE_LOW"],"type":"string"},"DiscrepanciesOutputParams":{"additionalProperties":false,"properties":{"issue_description":{"type":"string"},"related_item_ids":{"items":{"type":"number"},"type":"array"}},"required":["related_item_ids","issue_description"],"type":"object"},"EmailToken":{"additionalProperties":false,"description":"An email token used for unsubscribing and resubscribing from emails","properties":{"email_address":{"description":"The email address that this token will unsubscribe/resubscribe","format":"email","type":"string"},"exp":{"description":"The unix timestamp when this token expires.","example":5102023224,"type":"number"},"inspection_id":{"description":"The inspection id for the email this token will be attached to.","example":542,"type":"number"},"organization_id":{"description":"The id of the organization that this token will unsubscribe the email from.","example":123,"type":"number"}},"required":["organization_id","inspection_id","email_address","exp"],"type":"object"},"ExportInspectionPDFBody":{"additionalProperties":false,"description":"Request body for POST /inspections/{inspectionId}/export","properties":{"async":{"default":false,"description":"Whether to perform synchronously (in the request/response cycle) or queue for asynchronous export.\\n\\n If `false` (or unspecified), the PDF is exported synchronously and returned in the response. This is the default for backwards-compatibility, but is deprecated in favor of performing asynchronously.\\n\\n If `true`, the PDF is queued for asynchronous export and an `Operation` is returned to track its progress. This is recommended.","type":"boolean"},"exclude":{"default":[],"description":"Specific sections to exclude that are included by default. If you do not want to exclude any sections, you can omit this property.","items":{"enum":["questions","thumbnails","imageDetails","timeline"],"type":"string"},"type":"array"},"filter":{"additionalProperties":false,"description":"Filters which photos/videos are included in the PDF. Once specified, the PDF will only be generated based on the specific list of photos that are listed. By default all photos/videos are included. If you don't want to generate a PDF with a specific set of photos/videos, you can omit this property.","properties":{"photos":{"items":{"type":"number"},"type":"array"}},"required":["photos"],"type":"object"},"include":{"default":[],"description":"Additional sections to include that are NOT included by default. If you do not want to include any extra sections, you can omit this property.","items":{"enum":["inspectionNote",""],"type":"string"},"type":"array"},"tz":{"default":"UTC","description":"The IANA time zone name to use when displaying dates/times in the PDF. Defaults to UTC.","example":"America/New_York","type":"string"}},"type":"object"},"FlagDeviceRequestBody":{"additionalProperties":false,"description":"Request body for POST /inspections/{inspectionId}/flag-device","properties":{"comment":{"description":"The comment to apply to the activity log for this flag action.","type":"string"},"device_id":{"description":"The unique ID of the device","type":"number"},"flags":{"description":"The complete list of flags to apply to the device for this inspection. This will update the list of flags to match this array by adding and/or removing any existing flags.","items":{"$ref":"#/components/schemas/DeviceFlagType"},"type":"array"}},"required":["device_id","flags"],"type":"object"},"GetAIAnalysisSetQuestionTruepicsExamplesResult":{"items":{"additionalProperties":false,"properties":{"question":{"type":"string"},"question_id":{"type":"number"},"truepics":{"items":{"$ref":"#/components/schemas/QuestionTruepicExampleItem"},"type":"array"}},"required":["question","question_id","truepics"],"type":"object"},"type":"array"},"GetAIAnalysisSetResult":{"additionalProperties":false,"properties":{"api_version":{"description":"The current version number of the Vision API","example":"3.0.0","type":"string"},"message":{"description":"The human readable-status of the response","example":"Success","type":"string"},"response_code":{"description":"The HTTP status code of the response","example":200,"type":"integer"},"result":{"additionalProperties":false,"properties":{"id":{"type":"number"},"name":{"type":"string","nullable":true},"num_evaluated_truepics":{"type":"number"},"questions":{"items":{"type":"string"},"type":"array"}},"required":["id","num_evaluated_truepics","questions"],"type":"object"}},"required":["api_version","message","response_code","result"],"type":"object"},"GetAIAnalysisSetsResult":{"additionalProperties":false,"properties":{"api_version":{"description":"The current version number of the Vision API","example":"3.0.0","type":"string"},"message":{"description":"The human readable-status of the response","example":"Success","type":"string"},"pageCount":{"description":"The total number of pages for the given query","example":12,"type":"number"},"response_code":{"description":"The HTTP status code of the response","example":200,"type":"integer"},"result":{"items":{"additionalProperties":false,"properties":{"created_at":{"type":"string"},"id":{"type":"number"},"name":{"type":"string","nullable":true},"num_evaluated_truepics":{"type":"number"},"questions":{"items":{"type":"string"},"type":"array"}},"required":["id","created_at","num_evaluated_truepics","questions"],"type":"object"},"type":"array"},"total":{"description":"The total number of results for the given page","example":25,"type":"number"},"totalResults":{"description":"The total number of results for the given query","example":251,"type":"number"}},"required":["api_version","message","pageCount","response_code","result","total","totalResults"],"type":"object"},"GetAPICredentialsResult":{"$ref":"#/components/schemas/CreateAPICredentialsResult","description":"The response body for GET /auth/auth0"},"GetBearerInspectionResult":{"additionalProperties":false,"description":"Response Body for GET /inspections/bearer","properties":{"api_version":{"description":"The current version number of the Vision API","example":"3.0.0","type":"string"},"message":{"description":"The human readable-status of the response","example":"Success","type":"string"},"response_code":{"description":"The HTTP status code of the response","example":200,"type":"integer"},"result":{"additionalProperties":false,"description":"The Inspection schema with all properties optional","properties":{"address":{"description":"The physical address where the inspection is expected to take place","example":"532 Mission Street, Santa Clara, CA, USA","format":"address","type":"string"},"address_lat":{"description":"The latitude of `address` if set, otherwise `null`.","example":"40.0612708","type":"string"},"address_lng":{"description":"The longitude of `address` if set, otherwise `null`.","example":"40.0612708","type":"string"},"ai_status":{"$ref":"#/components/schemas/VerificationResult","description":"The AI analysis result for this inspection.","example":"pass"},"ai_status_details":{"$ref":"#/components/schemas/AIStatusDetails","description":"The details of the AI status for this inspection. This may include information about the criteria evaluation, any inconsistencies detected, and more."},"ai_status_reason":{"$ref":"#/components/schemas/AIStatusReason","description":"The reason for the AI analysis result for this inspection.","example":"COMPLETE_WITH_NO_INCONSISTENCIES"},"app_opened":true,"assigned_to_member_user_id":{"description":"The id of the user this inspection is assigned to.","example":19,"type":"number"},"created_at":{"description":"The date/time the resource was created","example":"2020-05-01T21:44:40.000Z","format":"date-time","type":"string"},"created_by_member_user_id":{"description":"The id of the member that created this inspection.","example":43,"type":"number"},"custom_field_values":{"description":"The values for the custom fields defined in the inspection type. The order of the values must match the order of the custom fields defined in the inspection type.  If the value is optional then you can provide null for that value.","example":["abc123","def123"],"items":{"type":"string"},"type":"array"},"customer_email_address":{"description":"The email address of the customer completing the inspection. Required if `send_methods.email` is `true`.","example":"kylorenxninja@gmail.com","format":"email","maxLength":255,"type":"string"},"customer_first_name":{"description":"The first name of the customer completing the inspection.","example":"Kylo","maxLength":255,"type":"string"},"customer_ip_address":{"description":"The IP address of the customer, recorded during the most recent photo capture inspection.","example":"123.532.124.174","format":"ipv4, ipv6","maxLength":255,"type":"string"},"customer_last_name":{"description":"The last name of the customer completing the inspection.","example":"Ren","maxLength":255,"type":"string"},"customer_name":{"description":"The full name of the customer who will be completing the inspection. If specified, then `customer_first_name` and `customer_last_name` will not be provided.","example":"Kylo Ren","maxLength":255,"type":"string"},"customer_phone_country":{"description":"The country code for the customer's phone number.","example":"US","maxLength":2,"type":"string"},"customer_phone_number":{"description":"The mobile number of the customer completing the inspection. Required if `send_methods.text` is `true`.","example":"3028675309","format":"phone","pattern":"/^[\\d]{10}$/","type":"string"},"deleted_at":{"description":"The date/time the inspection was deleted. `null` if not deleted.","example":"2020-05-01T21:44:40.000Z","format":"date-time","type":"string","nullable":true},"deleted_by_user_id":{"description":"The ID of the user who deleted the inspection. `null` if not deleted or auto-deleted by the system.","example":19,"type":"number","nullable":true},"email_auto_reply_sent":{"description":"The datetime an email automated reply was sent","example":"2023-01-04 15:11:39.642","format":"date-time","type":"string"},"group_id":{"description":"The id of the group this inspection is for.","example":23,"type":"number"},"id":{"description":"The id of the inspection request","example":1843,"type":"number"},"inspection_link":{"description":"A smart link to load the inspection in the Vision app. This link is generated by the Vision backend and is unique to the inspection.","example":"visionbytruepic.com/23AUkqg1xRb","type":"string"},"inspection_ready_criteria_text":{"description":"Free-form inspection-ready criteria text. Max length 10KB.","example":"Capture all rooms and appliances.","maxLength":10240,"type":"string","nullable":true},"inspection_status_id":{"$ref":"#/components/schemas/InspectionStatusId","description":"The id of the inspection status this inspection is in.","example":4},"inspection_type_id":{"description":"The id of the inspection type this inspection is for.","example":12,"type":"number"},"is_deleted":true,"is_expired":true,"max_distance_from_address_threshold":{"description":"The maximum distance, in meters, from the address that the photos/videos must be taken in order to be valid","example":1000,"type":"integer"},"message_supplement":{"description":"The message supplement (custom note) to be attached to the request text/email. Maximum length of 255 characters.","example":"Please complete in a timely manner","maxLength":255,"type":"string"},"organization_id":{"description":"The id of the organization this inspection is for.","example":117,"type":"number"},"outcome_id":{"description":"The id of the outcome of this inspection.","example":29,"type":"number"},"outcome_reason":{"description":"The reason for the outcome of this inspection","example":"Customer cancelled their service with our company","type":"string"},"photo_uploaded_at":{"description":"The date/time when the last photo/video was uploaded. ISO 8601 format.","example":"2020-05-01T21:44:40.000Z","format":"date-time","type":"string"},"platform":{"$ref":"#/components/schemas/InspectionPlatform","description":"The platform of our app that the inspection will be / has been performed on."},"scheduled_for":{"description":"The date/time (in UTC) the inspection is scheduled to be sent to the customer","example":"2020-05-01T21:44:40.000Z","format":"date-time","type":"string"},"scheduled_tz":{"description":"The IANA timezone name for the inspection's scheduled datetime. Used only for display purposes, as `scheduled_for` is in UTC.","example":"America/New_York","type":"string"},"send_methods":{"additionalProperties":false,"description":"The method(s) to send the inspection request to the customer completing the inspection.","properties":{"email":{"description":"When true, will send text messages to the customer_email_address","example":false,"type":"boolean"},"text":{"description":"When true, will send text messages to the customer_phone_number","example":true,"type":"boolean"}},"required":["text","email"],"type":"object"},"sent_auto_finish_reminders":{"description":"Times to send automated finish reminders","example":["10m","20m","30m"],"items":{"type":"string"},"type":"array"},"sent_auto_reminders":{"description":"Times to send automated reminders","example":["10m","20m","30m"],"items":{"type":"string"},"type":"array"},"sms_auto_reply_sent":{"description":"The datetime an sms automated reply was sent","example":"2023-01-04 15:11:39.642","format":"date-time","type":"string"},"team_id":{"description":"The id of the team this inspection is for.","example":182,"type":"number"},"updated_at":{"description":"The date/time the resource was last updated","example":"2020-05-01T21:44:40.000Z","format":"date-time","type":"string"},"verification_result":{"$ref":"#/components/schemas/VerificationResult","description":"The aggregate verification result of all photos/videos","example":"pass"}},"type":"object"}},"required":["api_version","message","response_code","result"],"type":"object"},"GetCustomFieldOptionSetResult":{"additionalProperties":false,"properties":{"api_version":{"description":"The current version number of the Vision API","example":"3.0.0","type":"string"},"message":{"description":"The human readable-status of the response","example":"Success","type":"string"},"response_code":{"description":"The HTTP status code of the response","example":200,"type":"integer"},"result":{"$ref":"#/components/schemas/PopulatedCustomFieldOptionSet","description":"A paginated list of Custom Field Option Sets with associated Inspection Types"}},"required":["api_version","message","response_code","result"],"type":"object"},"GetCustomFieldOptionSetsResult":{"additionalProperties":false,"properties":{"api_version":{"description":"The current version number of the Vision API","example":"3.0.0","type":"string"},"message":{"description":"The human readable-status of the response","example":"Success","type":"string"},"pageCount":{"description":"The total number of pages for the given query","example":12,"type":"number"},"response_code":{"description":"The HTTP status code of the response","example":200,"type":"integer"},"result":{"description":"A paginated list of Custom Field Option Sets with associated Inspection Types","items":{"$ref":"#/components/schemas/PopulatedCustomFieldOptionSet"},"type":"array"},"total":{"description":"The total number of results for the given page","example":25,"type":"number"},"totalResults":{"description":"The total number of results for the given query","example":251,"type":"number"}},"required":["api_version","message","pageCount","response_code","result","total","totalResults"],"type":"object"},"GetInspectionResult":{"additionalProperties":false,"description":"Response Body for GET /inspections/{inspectionId}","properties":{"api_version":{"description":"The current version number of the Vision API","example":"3.0.0","type":"string"},"message":{"description":"The human readable-status of the response","example":"Success","type":"string"},"response_code":{"description":"The HTTP status code of the response","example":200,"type":"integer"},"result":{"additionalProperties":false,"description":"An inspection object will all related data","properties":{"address":{"description":"The physical address where the inspection is expected to take place","example":"532 Mission Street, Santa Clara, CA, USA","format":"address","type":"string"},"address_lat":{"description":"The latitude of `address` if set, otherwise `null`.","example":"40.0612708","type":"string"},"address_lng":{"description":"The longitude of `address` if set, otherwise `null`.","example":"40.0612708","type":"string"},"ai_inspection_ready_result":{"anyOf":[{"$ref":"#/components/schemas/AIInspectionReadyResult"},{"nullable":true}]},"ai_status":{"$ref":"#/components/schemas/VerificationResult","description":"The AI analysis result for this inspection.","example":"pass"},"ai_status_details":{"$ref":"#/components/schemas/AIStatusDetails","description":"The details of the AI status for this inspection. This may include information about the criteria evaluation, any inconsistencies detected, and more."},"ai_status_reason":{"$ref":"#/components/schemas/AIStatusReason","description":"The reason for the AI analysis result for this inspection.","example":"COMPLETE_WITH_NO_INCONSISTENCIES"},"ai_user_criteria_result":{"anyOf":[{"$ref":"#/components/schemas/AIUserCriteriaResult"},{"nullable":true}]},"alert":{"$ref":"#/components/schemas/InspectionAlertResult"},"app_opened":true,"assigned_to_member_user":{"$ref":"#/components/schemas/User"},"assigned_to_member_user_id":{"description":"The id of the user this inspection is assigned to.","example":19,"type":"number"},"created_at":{"description":"The date/time the resource was created","example":"2020-05-01T21:44:40.000Z","format":"date-time","type":"string"},"created_by_member_user":{"$ref":"#/components/schemas/User"},"created_by_member_user_id":{"description":"The id of the member that created this inspection.","example":43,"type":"number"},"custom_field_values":{"description":"The values for the custom fields defined in the inspection type. The order of the values must match the order of the custom fields defined in the inspection type.  If the value is optional then you can provide null for that value.","example":["abc123","def123"],"items":{"type":"string"},"type":"array"},"customer_email_address":{"description":"The email address of the customer completing the inspection. Required if `send_methods.email` is `true`.","example":"kylorenxninja@gmail.com","format":"email","maxLength":255,"type":"string"},"customer_first_name":{"description":"The first name of the customer completing the inspection.","example":"Kylo","maxLength":255,"type":"string"},"customer_ip_address":{"description":"The IP address of the customer, recorded during the most recent photo capture inspection.","example":"123.532.124.174","format":"ipv4, ipv6","maxLength":255,"type":"string"},"customer_last_name":{"description":"The last name of the customer completing the inspection.","example":"Ren","maxLength":255,"type":"string"},"customer_name":{"description":"The full name of the customer who will be completing the inspection. If specified, then `customer_first_name` and `customer_last_name` will not be provided.","example":"Kylo Ren","maxLength":255,"type":"string"},"customer_phone_country":{"description":"The country code for the customer's phone number.","example":"US","maxLength":2,"type":"string"},"customer_phone_number":{"description":"The mobile number of the customer completing the inspection. Required if `send_methods.text` is `true`.","example":"3028675309","format":"phone","pattern":"/^[\\d]{10}$/","type":"string"},"deleted_at":{"description":"The date/time the inspection was deleted. `null` if not deleted.","example":"2020-05-01T21:44:40.000Z","format":"date-time","type":"string","nullable":true},"deleted_by_user_id":{"description":"The ID of the user who deleted the inspection. `null` if not deleted or auto-deleted by the system.","example":19,"type":"number","nullable":true},"devices":{"items":{"$ref":"#/components/schemas/InspectionDeviceInfo"},"type":"array"},"email_auto_reply_sent":{"description":"The datetime an email automated reply was sent","example":"2023-01-04 15:11:39.642","format":"date-time","type":"string"},"group":{"$ref":"#/components/schemas/Group"},"group_id":{"description":"The id of the group this inspection is for.","example":23,"type":"number"},"has_survey_available":{"type":"boolean"},"id":{"description":"The id of the inspection request","example":1843,"type":"number"},"insights":{"items":{"additionalProperties":false,"properties":{"type":{"$ref":"#/components/schemas/InspectionInsightType"}},"required":["type"],"type":"object"},"type":"array"},"inspection_link":{"description":"A smart link to load the inspection in the Vision app. This link is generated by the Vision backend and is unique to the inspection.","example":"visionbytruepic.com/23AUkqg1xRb","type":"string"},"inspection_ready_criteria_text":{"description":"Free-form inspection-ready criteria text. Max length 10KB.","example":"Capture all rooms and appliances.","maxLength":10240,"type":"string","nullable":true},"inspection_status_id":{"$ref":"#/components/schemas/InspectionStatusId","description":"The id of the inspection status this inspection is in.","example":4},"inspection_type":{"additionalProperties":false,"description":"An inspection type with attached list and message template set data","properties":{"created_at":{"description":"The date/time the resource was created","example":"2020-05-01T21:44:40.000Z","format":"date-time","type":"string"},"created_by_member_user_id":{"description":"the id of the user who created this inspection type. References `users.id`","example":2343,"type":"number"},"custom_fields":{"description":"The custom fields associated with this Inspection Type with any custom field values","items":{"$ref":"#/components/schemas/PopulatedCustomField"},"type":"array"},"customer_unique_id_2":{"$ref":"#/components/schemas/UniqueID2","deprecated":true,"description":"The details about customer unique id 2. This field still works in v2 but for v3 you must use `custom_fields` instead.","example":{"entry_method":"ENTRY_METHOD_TEXT","is_enabled":true,"is_required":false,"label":"Custom ID 2"}},"customer_unique_id_label":{"deprecated":true,"description":"The entry method for the customer unique id field. This field still works in v2 but for v3 you must use `custom_fields` instead.","example":"Custom ID","type":"string"},"entry_method":{"$ref":"#/components/schemas/CustomFieldEntryMethods","deprecated":true,"description":"The label for the customer unique id field. This field still works in v2 but for v3 you must use `custom_fields` instead."},"id":{"description":"The id of the inspection type","example":1843,"type":"number"},"inspection_alert_config":{"$ref":"#/components/schemas/InspectionAlertConfig","description":"The alert configuration that is used by this inspection type."},"inspection_alert_config_id":{"description":"The id of the inspection alert configuration that is used by this inspection type. References `inspection_alert_configs.id`","example":539,"type":"number"},"inspection_ready_criteria_text":{"description":"Optional inspection-ready criteria text for this inspection type.","example":"Capture the VIN plate clearly and include a full odometer photo.","type":"string","nullable":true},"is_address_required":{"description":"Controls whether an address is required for the inspection or not","example":1000,"type":"boolean"},"is_deleted":true,"is_list_locked":{"description":"When true, the list associated with this inspection type cannot be changed","example":false,"type":"boolean"},"language":{"$ref":"#/components/schemas/LocalizationLanguages","description":"The IETF language tag for the intended language of the inspection. Non-customizable text in emails will use the language specified here."},"list":{"additionalProperties":false,"description":"The list associated with this Inspection Type","properties":{"created_at":{"description":"The date/time the resource was created","example":"2020-05-01T21:44:40.000Z","format":"date-time","type":"string"},"created_by_member_user_id":{"description":"The id of the user that created this list","example":609,"type":"number"},"groups":{"$ref":"#/components/schemas/ListItemGroups","description":"The groups of items in the list","example":{"grp1":{"name":"Group 2"}}},"id":{"description":"The id of the resource.","example":1843,"type":"number"},"inspection_id":{"description":"The id of the inspection that this list belongs to","example":6342,"type":"number"},"inspection_types":{"items":{"$ref":"#/components/schemas/InspectionType"},"type":"array"},"is_deleted":true,"items":{"items":{"$ref":"#/components/schemas/ListItem"},"type":"array"},"name":{"description":"The auto-generated name of the list.","example":"List for Inspection 3527","type":"string"},"organization_id":{"description":"The id of the organization that this list belongs to","example":52,"type":"number"},"team_id":{"description":"The id of the team that this list belongs to","example":66,"type":"number"},"type":{"$ref":"#/components/schemas/ListType","description":"The type of the list. Must be `EVENT_TEMPLATE`, `EVENT_INSTANCE`, `SURVEY_TEMPLATE`, or `SURVEY_INSTANCE`","example":"EVENT_TEMPLATE"},"updated_at":{"description":"The date/time the resource was last updated","example":"2020-05-01T21:44:40.000Z","format":"date-time","type":"string"}},"required":["created_at","id","inspection_types","is_deleted","items","name","organization_id","type","updated_at"],"type":"object"},"list_id":{"description":"The id of the list that is used by this inspection type. References `lists.id`","example":3345,"type":"number"},"max_distance_from_address_threshold":{"description":"the maximum distance away from the configured inspection address that an inspection can be completed in meters.","example":1000,"type":"number"},"message_template_set":{"$ref":"#/components/schemas/MessageTemplateSet","description":"The message template set associated with this Inspection Type"},"message_template_set_id":{"description":"The id of the message template set that is used by this inspection type. References `message_template_sets.id`","example":539,"type":"number"},"modified_by_member_user_id":{"description":"the id of the user who last modified this inspection type. References `users.id`","example":2343,"type":"number"},"name":{"description":"The name of the inspection type","example":"My Type","type":"string"},"organization_id":{"description":"the id of the organization that this inspection type belongs to. References `organizations.id`.","example":14,"type":"number"},"outcome_set":{"$ref":"#/components/schemas/OutcomeSet","description":"The outcome set that is used by this inspection type."},"outcome_set_id":{"description":"The id of the outcome set that is used by this inspection type. References `outcome_sets.id`","example":539,"type":"number"},"team_id":{"deprecated":true,"description":"the id of the team that this inspection type belongs to. References `teams.id`. Note that this is no longer used, and inspection types can now be associated with multiple teams","example":124,"type":"number"},"teams":{"description":"The the teams that use this inspection type.","items":{"additionalProperties":false,"properties":{"id":{"description":"The id of the resource","example":1843,"type":"number"},"name":{"description":"The name of the team.","example":"Claims","type":"string"}},"required":["id"],"type":"object"},"type":"array"},"updated_at":{"description":"The date/time the resource was last updated","example":"2020-05-01T21:44:40.000Z","format":"date-time","type":"string"},"use_single_name_field":{"description":"When true, there is only one name for the user to fill out rather than a separate first name and last name field","example":true,"type":"boolean"}},"required":["created_at","custom_fields","id","is_address_required","is_deleted","is_list_locked","language","list","message_template_set","message_template_set_id","name","organization_id","team_id","updated_at","use_single_name_field"],"type":"object"},"inspection_type_id":{"description":"The id of the inspection type this inspection is for.","example":12,"type":"number"},"is_deleted":true,"is_expired":true,"list":{"additionalProperties":false,"properties":{"groups":{"$ref":"#/components/schemas/ListItemGroups","description":"The groups of items in the list","example":{"grp1":{"name":"Group 2"}}},"id":{"description":"The id of the resource.","example":1843,"type":"number"},"items":{"items":{"$ref":"#/components/schemas/InspectionListItemWithPhotos"},"type":"array"},"name":{"description":"The auto-generated name of the list.","example":"List for Inspection 3527","type":"string"}},"required":["id","items","name"],"type":"object"},"locations":{"items":{"$ref":"#/components/schemas/PopulatedLocation"},"type":"array"},"max_distance_from_address_threshold":{"description":"The maximum distance, in meters, from the address that the photos/videos must be taken in order to be valid","example":1000,"type":"integer"},"message_supplement":{"description":"The message supplement (custom note) to be attached to the request text/email. Maximum length of 255 characters.","example":"Please complete in a timely manner","maxLength":255,"type":"string"},"organization":{"$ref":"#/components/schemas/Organization"},"organization_enabled_features":{"items":{"$ref":"#/components/schemas/OrganizationEnabledFeature"},"type":"array"},"organization_id":{"description":"The id of the organization this inspection is for.","example":117,"type":"number"},"organization_team":{"$ref":"#/components/schemas/Team"},"outcome":{"$ref":"#/components/schemas/Outcome"},"outcome_id":{"description":"The id of the outcome of this inspection.","example":29,"type":"number"},"outcome_reason":{"description":"The reason for the outcome of this inspection","example":"Customer cancelled their service with our company","type":"string"},"photo_counts":{},"photo_uploaded_at":{"description":"The date/time when the last photo/video was uploaded. ISO 8601 format.","example":"2020-05-01T21:44:40.000Z","format":"date-time","type":"string"},"photos":{"items":{"$ref":"#/components/schemas/InspectionTruepic"},"type":"array"},"platform":{"$ref":"#/components/schemas/InspectionPlatform","description":"The platform of our app that the inspection will be / has been performed on."},"scheduled_for":{"description":"The date/time (in UTC) the inspection is scheduled to be sent to the customer","example":"2020-05-01T21:44:40.000Z","format":"date-time","type":"string"},"scheduled_tz":{"description":"The IANA timezone name for the inspection's scheduled datetime. Used only for display purposes, as `scheduled_for` is in UTC.","example":"America/New_York","type":"string"},"send_methods":{"additionalProperties":false,"description":"The method(s) to send the inspection request to the customer completing the inspection.","properties":{"email":{"description":"When true, will send text messages to the customer_email_address","example":false,"type":"boolean"},"text":{"description":"When true, will send text messages to the customer_phone_number","example":true,"type":"boolean"}},"required":["text","email"],"type":"object"},"sent_auto_finish_reminders":{"description":"Times to send automated finish reminders","example":["10m","20m","30m"],"items":{"type":"string"},"type":"array"},"sent_auto_reminders":{"description":"Times to send automated reminders","example":["10m","20m","30m"],"items":{"type":"string"},"type":"array"},"sms_auto_reply_sent":{"description":"The datetime an sms automated reply was sent","example":"2023-01-04 15:11:39.642","format":"date-time","type":"string"},"status":{"$ref":"#/components/schemas/InspectionStatus"},"team_id":{"description":"The id of the team this inspection is for.","example":182,"type":"number"},"timeline":{"items":{"additionalProperties":false,"description":"A TimeLineAction with the action type and location populated","properties":{"action_type":{"$ref":"#/components/schemas/TimelineActionType"},"created_at":{"description":"The date/time the resource was created","example":"2020-05-01T21:44:40.000Z","format":"date-time","type":"string"},"customer_user_id":{"description":"The id of the app user that performed this action","example":4335,"type":"number"},"data":{"additionalProperties":false,"description":"An object containing any additional data related to the action.","properties":{"flags":{"additionalProperties":false,"description":"The flags and comment applied for the ACTION_DEVICE_FLAGS_CHANGED activity","properties":{"comment":{"description":"The comment to apply to the activity log for this flag action.","type":"string"},"flags":{"description":"The complete list of flags to apply to the device for this inspection. This will update the list of flags to match this array by adding and/or removing any existing flags.","items":{"$ref":"#/components/schemas/DeviceFlagType"},"type":"array"}},"required":["flags"],"type":"object"},"is_details_full_message":{"description":"Whether the full message was sent","example":true,"type":"boolean"},"list_item_id":{"description":"The id of the associated list item","example":12345,"type":"number"},"location":{"$ref":"#/components/schemas/LensActivityLocationData","description":"An optional location associated with the action"},"message_id":{"description":"The Sendgrid email message id of the associated message","example":"DGnO3FNol23452ewf9v-7786453638cc-xx435l-1-646B123C-53.0","type":"string"},"reason":{"description":"If the action was triggered by a Lens activity, this will contain details about the activity","example":"timestamp_old","type":"string"},"tags":{"description":"An array of tag strings describing an activity","items":{"type":"string"},"type":"array"},"truepic_id":{"description":"The id of the associated Truepic","example":12345,"type":"number"}},"type":"object"},"details":{"description":"Any additional information, such as a member's custom message or more descriptive text.","type":"number","nullable":true},"device_fingerprint_details_request_id":{"description":"The id of the device fingerprint record","type":"string"},"device_id":{"description":"The id of the device record","example":1843,"type":"number"},"device_validation_status":{"$ref":"#/components/schemas/DeviceValidationStatus","description":"The determined status of the fingerprint data.","example":"VALID"},"id":{"description":"The id of the resource.","example":1843,"type":"number"},"inspection_id":{"description":"The id of the inspection this action occurred on","example":4335,"type":"number"},"is_deleted":true,"location":{"$ref":"#/components/schemas/PopulatedLocation"},"location_id":{"description":"The id of the location record","example":12345,"type":"number"},"member_user_id":{"description":"The id of the dashboard user that performed this action","example":4335,"type":"number"},"meta":{"description":"Any meta information, such as the URL when a new smart link is generated.","type":"string"},"timeline_action_type_id":{"description":"The id of the action type","example":12,"type":"number"},"updated_at":{"description":"The date/time the resource was last updated","example":"2020-05-01T21:44:40.000Z","format":"date-time","type":"string"}},"required":["action_type","created_at","id","inspection_id","location","updated_at"],"type":"object"},"type":"array"},"updated_at":{"description":"The date/time the resource was last updated","example":"2020-05-01T21:44:40.000Z","format":"date-time","type":"string"},"verification_result":{"$ref":"#/components/schemas/VerificationResult","description":"The aggregate verification result of all photos/videos","example":"pass"},"organization_token_status":{"additionalProperties":false,"properties":{"expires":{"type":"number","nullable":true},"is_valid":{"type":"boolean"}},"required":["is_valid"],"type":"object"}},"required":["alert","app_opened","assigned_to_member_user","assigned_to_member_user_id","created_at","created_by_member_user","created_by_member_user_id","custom_field_values","organization_token_status","devices","has_survey_available","id","insights","inspection_status_id","inspection_type","inspection_type_id","is_deleted","is_expired","list","locations","organization","organization_enabled_features","organization_id","organization_team","photo_counts","photos","send_methods","status","team_id","timeline","updated_at"],"type":"object"}},"required":["api_version","message","response_code","result"],"type":"object"},"GetInspectionTypeResult":{"additionalProperties":false,"description":"The response body for GET /lists/{listId}","properties":{"api_version":{"description":"The current version number of the Vision API","example":"3.0.0","type":"string"},"message":{"description":"The human readable-status of the response","example":"Success","type":"string"},"response_code":{"description":"The HTTP status code of the response","example":200,"type":"integer"},"result":{"additionalProperties":false,"properties":{"created_at":{"description":"The date/time the resource was created","example":"2020-05-01T21:44:40.000Z","format":"date-time","type":"string"},"created_by_member_user_id":{"description":"the id of the user who created this inspection type. References `users.id`","example":2343,"type":"number"},"custom_fields":{"description":"The custom fields associated with this Inspection Type with any custom field values","items":{"$ref":"#/components/schemas/PopulatedCustomField"},"type":"array"},"customer_unique_id_2":{"$ref":"#/components/schemas/UniqueID2","deprecated":true,"description":"The details about customer unique id 2. This field still works in v2 but for v3 you must use `custom_fields` instead.","example":{"entry_method":"ENTRY_METHOD_TEXT","is_enabled":true,"is_required":false,"label":"Custom ID 2"}},"customer_unique_id_label":{"deprecated":true,"description":"The entry method for the customer unique id field. This field still works in v2 but for v3 you must use `custom_fields` instead.","example":"Custom ID","type":"string"},"entry_method":{"$ref":"#/components/schemas/CustomFieldEntryMethods","deprecated":true,"description":"The label for the customer unique id field. This field still works in v2 but for v3 you must use `custom_fields` instead."},"id":{"description":"The id of the inspection type","example":1843,"type":"number"},"inspection_alert_config":{"$ref":"#/components/schemas/InspectionAlertConfig","description":"The alert configuration that is used by this inspection type."},"inspection_alert_config_id":{"description":"The id of the inspection alert configuration that is used by this inspection type. References `inspection_alert_configs.id`","example":539,"type":"number"},"inspection_ready_criteria_text":{"description":"Optional inspection-ready criteria text for this inspection type.","example":"Capture the VIN plate clearly and include a full odometer photo.","type":"string","nullable":true},"is_address_required":{"description":"Controls whether an address is required for the inspection or not","example":1000,"type":"boolean"},"is_list_locked":{"description":"When true, the list associated with this inspection type cannot be changed","example":false,"type":"boolean"},"language":{"$ref":"#/components/schemas/LocalizationLanguages","description":"The IETF language tag for the intended language of the inspection. Non-customizable text in emails will use the language specified here."},"list":{"additionalProperties":false,"description":"The list associated with this Inspection Type","properties":{"created_at":{"description":"The date/time the resource was created","example":"2020-05-01T21:44:40.000Z","format":"date-time","type":"string"},"created_by_member_user_id":{"description":"The id of the user that created this list","example":609,"type":"number"},"groups":{"$ref":"#/components/schemas/ListItemGroups","description":"The groups of items in the list","example":{"grp1":{"name":"Group 2"}}},"id":{"description":"The id of the resource.","example":1843,"type":"number"},"inspection_id":{"description":"The id of the inspection that this list belongs to","example":6342,"type":"number"},"inspection_types":{"items":{"$ref":"#/components/schemas/InspectionType"},"type":"array"},"is_deleted":true,"items":{"items":{"$ref":"#/components/schemas/ListItem"},"type":"array"},"name":{"description":"The auto-generated name of the list.","example":"List for Inspection 3527","type":"string"},"organization_id":{"description":"The id of the organization that this list belongs to","example":52,"type":"number"},"team_id":{"description":"The id of the team that this list belongs to","example":66,"type":"number"},"type":{"$ref":"#/components/schemas/ListType","description":"The type of the list. Must be `EVENT_TEMPLATE`, `EVENT_INSTANCE`, `SURVEY_TEMPLATE`, or `SURVEY_INSTANCE`","example":"EVENT_TEMPLATE"},"updated_at":{"description":"The date/time the resource was last updated","example":"2020-05-01T21:44:40.000Z","format":"date-time","type":"string"}},"required":["created_at","id","inspection_types","is_deleted","items","name","organization_id","type","updated_at"],"type":"object"},"list_id":{"description":"The id of the list that is used by this inspection type. References `lists.id`","example":3345,"type":"number"},"max_distance_from_address_threshold":{"description":"the maximum distance away from the configured inspection address that an inspection can be completed in meters.","example":1000,"type":"number"},"message_template_set":{"$ref":"#/components/schemas/MessageTemplateSet","description":"The message template set associated with this Inspection Type"},"message_template_set_id":{"description":"The id of the message template set that is used by this inspection type. References `message_template_sets.id`","example":539,"type":"number"},"modified_by_member_user_id":{"description":"the id of the user who last modified this inspection type. References `users.id`","example":2343,"type":"number"},"name":{"description":"The name of the inspection type","example":"My Type","type":"string"},"outcome_set":{"$ref":"#/components/schemas/OutcomeSet","description":"The outcome set that is used by this inspection type."},"outcome_set_id":{"description":"The id of the outcome set that is used by this inspection type. References `outcome_sets.id`","example":539,"type":"number"},"teams":{"description":"The the teams that use this inspection type.","items":{"additionalProperties":false,"properties":{"id":{"description":"The id of the resource","example":1843,"type":"number"},"name":{"description":"The name of the team.","example":"Claims","type":"string"}},"required":["id"],"type":"object"},"type":"array"},"updated_at":{"description":"The date/time the resource was last updated","example":"2020-05-01T21:44:40.000Z","format":"date-time","type":"string"},"use_single_name_field":{"description":"When true, there is only one name for the user to fill out rather than a separate first name and last name field","example":true,"type":"boolean"}},"required":["id","name","is_list_locked","message_template_set_id","is_address_required","use_single_name_field","language","created_at","updated_at","custom_fields","list","message_template_set"],"type":"object"}},"required":["api_version","message","response_code","result"],"type":"object"},"GetInspectionTypesResult":{"additionalProperties":false,"description":"The response body for GET /lists","properties":{"api_version":{"description":"The current version number of the Vision API","example":"3.0.0","type":"string"},"message":{"description":"The human readable-status of the response","example":"Success","type":"string"},"pageCount":{"description":"The total number of pages for the given query","example":12,"type":"number"},"response_code":{"description":"The HTTP status code of the response","example":200,"type":"integer"},"result":{"items":{"$ref":"#/components/schemas/InspectionTypeData"},"type":"array"},"total":{"description":"The total number of results for the given page","example":25,"type":"number"},"totalResults":{"description":"The total number of results for the given query","example":251,"type":"number"}},"required":["api_version","message","pageCount","response_code","result","total","totalResults"],"type":"object"},"GetInspectionsResult":{"additionalProperties":false,"description":"Response Body for GET /inspections","properties":{"api_version":{"description":"The current version number of the Vision API","example":"3.0.0","type":"string"},"message":{"description":"The human readable-status of the response","example":"Success","type":"string"},"pageCount":{"description":"The total number of pages for the given query","example":12,"type":"number"},"response_code":{"description":"The HTTP status code of the response","example":200,"type":"integer"},"result":{"description":"A paginated list of inspections","items":{"$ref":"#/components/schemas/Inspection"},"type":"array"},"total":{"description":"The total number of results for the given page","example":25,"type":"number"},"totalResults":{"description":"The total number of results for the given query","example":251,"type":"number"}},"required":["api_version","message","pageCount","response_code","result","total","totalResults"],"type":"object"},"GetLandingPageContentResult":{"additionalProperties":false,"properties":{"api_version":{"description":"The current version number of the Vision API","example":"3.0.0","type":"string"},"message":{"description":"The human readable-status of the response","example":"Success","type":"string"},"response_code":{"description":"The HTTP status code of the response","example":200,"type":"integer"},"result":{"$ref":"#/components/schemas/LandingPageContentSerialized"}},"required":["api_version","message","response_code","result"],"type":"object"},"GetLandingPageResult":{"additionalProperties":false,"properties":{"api_version":{"description":"The current version number of the Vision API","example":"3.0.0","type":"string"},"message":{"description":"The human readable-status of the response","example":"Success","type":"string"},"response_code":{"description":"The HTTP status code of the response","example":200,"type":"integer"},"result":{"$ref":"#/components/schemas/LandingPageSerialized"}},"required":["api_version","message","response_code","result"],"type":"object"},"GetLandingPagesResult":{"additionalProperties":false,"properties":{"api_version":{"description":"The current version number of the Vision API","example":"3.0.0","type":"string"},"message":{"description":"The human readable-status of the response","example":"Success","type":"string"},"pageCount":{"description":"The total number of pages for the given query","example":12,"type":"number"},"response_code":{"description":"The HTTP status code of the response","example":200,"type":"integer"},"result":{"items":{"$ref":"#/components/schemas/LandingPageSerialized"},"type":"array"},"total":{"description":"The total number of results for the given page","example":25,"type":"number"},"totalResults":{"description":"The total number of results for the given query","example":251,"type":"number"}},"required":["api_version","message","pageCount","response_code","result","total","totalResults"],"type":"object"},"GetListResult":{"additionalProperties":false,"description":"The response body for GET /lists/{listId}","properties":{"api_version":{"description":"The current version number of the Vision API","example":"3.0.0","type":"string"},"message":{"description":"The human readable-status of the response","example":"Success","type":"string"},"response_code":{"description":"The HTTP status code of the response","example":200,"type":"integer"},"result":{"additionalProperties":false,"description":"A list with attached list items and or inspection types","properties":{"created_at":{"description":"The date/time the resource was created","example":"2020-05-01T21:44:40.000Z","format":"date-time","type":"string"},"created_by_member_user_id":{"description":"The id of the user that created this list","example":609,"type":"number"},"groups":{"$ref":"#/components/schemas/ListItemGroups","description":"The groups of items in the list","example":{"grp1":{"name":"Group 2"}}},"id":{"description":"The id of the resource.","example":1843,"type":"number"},"inspection_id":{"description":"The id of the inspection that this list belongs to","example":6342,"type":"number"},"inspection_types":{"items":{"$ref":"#/components/schemas/InspectionType"},"type":"array"},"is_deleted":true,"items":{"items":{"$ref":"#/components/schemas/ListItem"},"type":"array"},"name":{"description":"The auto-generated name of the list.","example":"List for Inspection 3527","type":"string"},"organization_id":{"description":"The id of the organization that this list belongs to","example":52,"type":"number"},"team_id":{"description":"The id of the team that this list belongs to","example":66,"type":"number"},"type":{"$ref":"#/components/schemas/ListType","description":"The type of the list. Must be `EVENT_TEMPLATE`, `EVENT_INSTANCE`, `SURVEY_TEMPLATE`, or `SURVEY_INSTANCE`","example":"EVENT_TEMPLATE"},"updated_at":{"description":"The date/time the resource was last updated","example":"2020-05-01T21:44:40.000Z","format":"date-time","type":"string"}},"required":["created_at","id","inspection_types","is_deleted","items","name","organization_id","type","updated_at"],"type":"object"}},"required":["api_version","message","response_code","result"],"type":"object"},"GetListsResult":{"additionalProperties":false,"description":"The response body for GET /lists","properties":{"api_version":{"description":"The current version number of the Vision API","example":"3.0.0","type":"string"},"message":{"description":"The human readable-status of the response","example":"Success","type":"string"},"pageCount":{"description":"The total number of pages for the given query","example":12,"type":"number"},"response_code":{"description":"The HTTP status code of the response","example":200,"type":"integer"},"result":{"items":{"additionalProperties":false,"properties":{"created_at":{"description":"The date/time the resource was created","example":"2020-05-01T21:44:40.000Z","format":"date-time","type":"string"},"created_by_member_user_id":{"description":"The id of the user that created this list","example":609,"type":"number"},"groups":{"$ref":"#/components/schemas/ListItemGroups","description":"The groups of items in the list","example":{"grp1":{"name":"Group 2"}}},"id":{"description":"The id of the resource.","example":1843,"type":"number"},"inspection_id":{"description":"The id of the inspection that this list belongs to","example":6342,"type":"number"},"name":{"description":"The auto-generated name of the list.","example":"List for Inspection 3527","type":"string"},"team_id":{"description":"The id of the team that this list belongs to","example":66,"type":"number"},"type":{"$ref":"#/components/schemas/ListType","description":"The type of the list. Must be `EVENT_TEMPLATE`, `EVENT_INSTANCE`, `SURVEY_TEMPLATE`, or `SURVEY_INSTANCE`","example":"EVENT_TEMPLATE"},"updated_at":{"description":"The date/time the resource was last updated","example":"2020-05-01T21:44:40.000Z","format":"date-time","type":"string"}},"required":["id","name","type","created_at","updated_at"],"type":"object"},"type":"array"},"total":{"description":"The total number of results for the given page","example":25,"type":"number"},"totalResults":{"description":"The total number of results for the given query","example":251,"type":"number"}},"required":["api_version","message","pageCount","response_code","result","total","totalResults"],"type":"object"},"GetLoggedInUserResult":{"additionalProperties":false,"description":"The result for GET /auth/user","properties":{"user":{"additionalProperties":false,"properties":{"actingAsRole":{"description":"The role the user is acting as. Only available to super admins","type":"string"},"auth_id":{"description":"The auth identifier of the user.","example":"wawqZ8nABRWEpxjZKegwe@clients","type":"string"},"created_at":{"description":"The date/time the resource was created","example":"2020-05-01T21:44:40.000Z","format":"date-time","type":"string"},"decodedToken":{"$ref":"#/components/schemas/EmailToken"},"email":{"description":"The email address of the user.","example":"kylorenxninja@potato.com","format":"email","type":"string"},"first_name":{"description":"The first name of the user.","example":"Kylo","type":"string"},"group":{"$ref":"#/components/schemas/SerializedGroup"},"hasAccessToMultipleOrganizations":{"type":"boolean"},"id":{"description":"The id of the user","example":1843,"type":"number"},"inspection_id":{"description":"The id of the inspection this user belongs to. Indicates this is a mobile app user performing an inspection. References `inspections.id`","example":2412,"type":"number"},"isActiveUser":{"type":"boolean"},"isBot":{"type":"boolean"},"isCustomer":{"type":"boolean"},"isGroupMember":{"type":"boolean"},"isMember":{"description":"Members can create inspections and review all inspections in assigned teams.","example":true,"type":"boolean"},"isMemberAdmin":{"description":"Administrators have full access to account settings. They can manage users, configure inspections, access reports, create inspections, and review all inspections.","example":false,"type":"boolean"},"isMemberOwnInspections":{"description":"These members can create inspections and review any inspection assigned to them.","example":true,"type":"boolean"},"isMemberReport":{"description":"These members can access reports, create inspections, and review all inspections assigned to them.","example":true,"type":"boolean"},"isSuperAdmin":{"description":"Super Admins are for Truepic staff to setup and configure organizations.","example":false,"type":"boolean"},"isViewOnly":{"description":"These members can only view inspections in assigned teams.","example":false,"type":"boolean"},"jwt":{"type":"string"},"last_name":{"description":"The last name of the user.","example":"Ren","type":"string"},"last_session_start":{"description":"The date/time the user last logged in","example":"2020-05-01T21:44:40.000Z","format":"date-time","type":"string"},"organization":{"additionalProperties":false,"description":"The user's organization information.","properties":{"auto_delete_customer_data_after_days":{"default":null,"description":"The number of days after which customer data (inspections, truepics, etc.) will be automatically deleted. A null value disables automatic deletion.","example":365,"type":"number","nullable":true},"id":{"description":"The id of the resource.","example":1843,"type":"number"},"is_mfa_required":true,"name":{"description":"The name of the organization.","example":"Quality Capital","type":"string"},"organization_slug":{"description":"The organization_slug of the organization used to access Vision.","example":"vision-test","type":"string"}},"required":["id","is_mfa_required"],"type":"object"},"organization_enabled_features":{"description":"The enabled features of the user's organization.","items":{"$ref":"#/components/schemas/OrganizationEnabledFeature"},"type":"array"},"organization_id":{"description":"The id of the organization this user belongs to.","example":117,"type":"number"},"organizationsUserHasAccessTo":{"items":{"type":"number"},"type":"array"},"phone_number":{"description":"The phone number of the user.","example":"5558675309","format":"phone","type":"string"},"provider":{"$ref":"#/components/schemas/Provider"},"roles":{"description":"A list of roles assigned to the user.","items":{"additionalProperties":false,"properties":{"id":{"description":"The id of the resource.","example":1843,"type":"number"},"id_internal":{"$ref":"#/components/schemas/VisionRole","description":"The code-parseable identifier of the role.","example":"VISION_AGENT_ADMIN"},"name":{"description":"The human-readable name of the role.","example":"Administrator","type":"string"}},"required":["id","id_internal","name"],"type":"object"},"type":"array"},"search":{"description":"Search terminology for indexing the user","example":"'member':2 'bob':1 'bob@aol.com':3","type":"string"},"team_id":{"description":"The id of the team this user belongs to.","example":521,"type":"number"},"teams":{"anyOf":[{"items":{"type":"number"},"type":"array"},{"items":{"$ref":"#/components/schemas/PopulatedTeam"},"type":"array"}]},"updated_at":{"description":"The date/time the resource was last updated","example":"2020-05-01T21:44:40.000Z","format":"date-time","type":"string"}},"required":["created_at","decodedToken","group","hasAccessToMultipleOrganizations","id","isActiveUser","isBot","isOrganization","isGroupMember","isMember","isMemberAdmin","isMemberOwnInspections","isMemberReport","isSuperAdmin","isViewOnly","organizationsUserHasAccessTo","roles","teams","updated_at"],"type":"object"}},"required":["user"],"type":"object"},"GetMessageTemplateResult":{"additionalProperties":false,"description":"The response body for GET /lists/{listId}","properties":{"api_version":{"description":"The current version number of the Vision API","example":"3.0.0","type":"string"},"message":{"description":"The human readable-status of the response","example":"Success","type":"string"},"response_code":{"description":"The HTTP status code of the response","example":200,"type":"integer"},"result":{"$ref":"#/components/schemas/MessageTemplateSetData"}},"required":["api_version","message","response_code","result"],"type":"object"},"GetMessageTemplateSetsResult":{"additionalProperties":false,"description":"The response body for GET /lists","properties":{"api_version":{"description":"The current version number of the Vision API","example":"3.0.0","type":"string"},"message":{"description":"The human readable-status of the response","example":"Success","type":"string"},"pageCount":{"description":"The total number of pages for the given query","example":12,"type":"number"},"response_code":{"description":"The HTTP status code of the response","example":200,"type":"integer"},"result":{"items":{"$ref":"#/components/schemas/MessageTemplateSetData"},"type":"array"},"total":{"description":"The total number of results for the given page","example":25,"type":"number"},"totalResults":{"description":"The total number of results for the given query","example":251,"type":"number"}},"required":["api_version","message","pageCount","response_code","result","total","totalResults"],"type":"object"},"GetOperationResult":{"additionalProperties":false,"description":"The response body for GET /operations/{operationId}","properties":{"api_version":{"description":"The current version number of the Vision API","example":"3.0.0","type":"string"},"message":{"description":"The human readable-status of the response","example":"Success","type":"string"},"response_code":{"description":"The HTTP status code of the response","example":200,"type":"integer"},"result":{"$ref":"#/components/schemas/Operation"}},"required":["api_version","message","response_code","result"],"type":"object"},"GetSupportByBearerResult":{"additionalProperties":false,"description":"The response body for GET /inspections/bearer/support","properties":{"api_version":{"description":"The current version number of the Vision API","example":"3.0.0","type":"string"},"message":{"description":"The human readable-status of the response","example":"Success","type":"string"},"response_code":{"description":"The HTTP status code of the response","example":200,"type":"integer"},"result":{"additionalProperties":false,"properties":{"api_key":{"description":"The Intercom API key for the platform based on user agent.","type":"string"},"app_id":{"description":"The Intercom app ID.","type":"string"},"user_jwt":{"description":"The user JWT for securing the Intercom messenger.","type":"string"}},"required":["api_key","app_id","user_jwt"],"type":"object"}},"required":["api_version","message","response_code","result"],"type":"object"},"GetTeamResult":{"additionalProperties":false,"description":"The response body for the GET /teams/{teamId} endpoint","properties":{"api_version":{"description":"The current version number of the Vision API","example":"3.0.0","type":"string"},"message":{"description":"The human readable-status of the response","example":"Success","type":"string"},"response_code":{"description":"The HTTP status code of the response","example":200,"type":"integer"},"result":{"additionalProperties":false,"properties":{"allow_image_deletes":{"default":true,"description":"Whether to allow app users to delete images during an inspection.","example":true,"type":"boolean"},"allow_list_item_capture_max":{"default":false,"description":"Whether app users should have a maximum limit of captures per list item.","example":true,"type":"boolean"},"app_success_message":{"description":"The message displayed to the customer on completion of the inspection.","type":"string"},"auto_finish_reminder_duration":{"description":"The amount of time until an auto-reminder is sent for incomplete inspections that have some photos/videos/question answers. `null` means auto-reminders are disabled. Any format supported by https://github.com/vercel/ms is valid.  Multiple reminders can be specified by separating them with a comma.","example":"12h,1d","type":"string"},"auto_reminder_duration":{"description":"The amount of time until an auto-reminder is sent for inspections without photos/videos/question answers. `null` means auto-reminders are disabled. Any format supported by https://github.com/vercel/ms is valid.  Multiple durations can be specified by separating them with a comma.","example":"12h,1d","type":"string"},"color_primary":{"description":"The primary hex color code used for branding in the app.","example":"#0F7EC1","type":"string"},"created_at":{"description":"The date/time the resource was created","example":"2020-05-01T21:44:40.000Z","format":"date-time","type":"string"},"custom_smart_link_url":{"description":"The custom URL to use when generating an inspection smart link. A short token is appended to the end as a hash (e.g., `#lx6pzExWILBMnhR`).","type":"string"},"customer_app_label":{"description":"The company name to display in the app.","example":"Quality Capital","type":"string"},"customer_item_label":{"description":"The word for an \"item\" in the context of the team.","example":"jewelry","type":"string"},"customer_support_label":{"description":"The label displayed for contacting support in the app.","example":"Contact Us","type":"string"},"customer_support_number":{"description":"The phone number attached to text messages for app users to contact for customer support.","example":"1 (516) 271-1526","format":"phone","type":"string"},"default_list_item_capture_max":{"description":"The maximum number of captures an app user can create for a list item in an inspection. Only used if allow_list_item_capture_max is `true`","example":20,"type":"number"},"distance_from_customer_address_threshold":{"description":"The distance (in meters) from the customer's address a photo/video can be taken before being flagged. `null` can be set to disable the flag.","example":1500,"type":"number"},"enabled_features":{"additionalProperties":false,"description":"A configuration object showing the the features that are enabled for this team.","properties":{"pdf_attachments":{"description":"Defines how the team wants PDF files attached to messages.","items":{"$ref":"#/components/schemas/PDFAttachmentSettings"},"type":"array"},"respond_to_text_messages":{"description":"Whether this team can respond to text messages from the Vision dashboard","example":true,"type":"boolean"},"web_camera":{"description":"Whether this team's inspections should be performed using the web camera.","example":true,"type":"boolean"}},"required":["respond_to_text_messages","web_camera"],"type":"object"},"gps_threshold":{"description":"The accuracy threshold that GPS coordinates must not exceed in meters.","example":1500,"type":"number"},"group_id_label":{"description":"The label to describe the identifier that the organization uses to reference the group in their system.","example":"Dealer ID","type":"string"},"groups":{"additionalProperties":false,"properties":{"address":{"description":"The address of the group","example":"7817 Ivanhoe Avenue, La Jolla, CA 92037","type":"string"},"id":{"description":"The id of the resource.","example":1843,"type":"number"},"name":{"description":"The name of the group","example":"Acura of La Jolla","type":"string"}},"required":["id","name"],"type":"object"},"include_list":true,"inspection_types":{"items":{"additionalProperties":false,"description":"An inspection type with attached list and message template set data","properties":{"created_at":{"description":"The date/time the resource was created","example":"2020-05-01T21:44:40.000Z","format":"date-time","type":"string"},"created_by_member_user_id":{"description":"the id of the user who created this inspection type. References `users.id`","example":2343,"type":"number"},"custom_fields":{"description":"The custom fields associated with this Inspection Type with any custom field values","items":{"$ref":"#/components/schemas/PopulatedCustomField"},"type":"array"},"customer_unique_id_2":{"$ref":"#/components/schemas/UniqueID2","deprecated":true,"description":"The details about customer unique id 2. This field still works in v2 but for v3 you must use `custom_fields` instead.","example":{"entry_method":"ENTRY_METHOD_TEXT","is_enabled":true,"is_required":false,"label":"Custom ID 2"}},"customer_unique_id_label":{"deprecated":true,"description":"The entry method for the customer unique id field. This field still works in v2 but for v3 you must use `custom_fields` instead.","example":"Custom ID","type":"string"},"entry_method":{"$ref":"#/components/schemas/CustomFieldEntryMethods","deprecated":true,"description":"The label for the customer unique id field. This field still works in v2 but for v3 you must use `custom_fields` instead."},"id":{"description":"The id of the inspection type","example":1843,"type":"number"},"inspection_alert_config":{"$ref":"#/components/schemas/InspectionAlertConfig","description":"The alert configuration that is used by this inspection type."},"inspection_alert_config_id":{"description":"The id of the inspection alert configuration that is used by this inspection type. References `inspection_alert_configs.id`","example":539,"type":"number"},"inspection_ready_criteria_text":{"description":"Optional inspection-ready criteria text for this inspection type.","example":"Capture the VIN plate clearly and include a full odometer photo.","type":"string","nullable":true},"is_address_required":{"description":"Controls whether an address is required for the inspection or not","example":1000,"type":"boolean"},"is_deleted":true,"is_list_locked":{"description":"When true, the list associated with this inspection type cannot be changed","example":false,"type":"boolean"},"language":{"$ref":"#/components/schemas/LocalizationLanguages","description":"The IETF language tag for the intended language of the inspection. Non-customizable text in emails will use the language specified here."},"list":{"additionalProperties":false,"description":"The list associated with this Inspection Type","properties":{"created_at":{"description":"The date/time the resource was created","example":"2020-05-01T21:44:40.000Z","format":"date-time","type":"string"},"created_by_member_user_id":{"description":"The id of the user that created this list","example":609,"type":"number"},"groups":{"$ref":"#/components/schemas/ListItemGroups","description":"The groups of items in the list","example":{"grp1":{"name":"Group 2"}}},"id":{"description":"The id of the resource.","example":1843,"type":"number"},"inspection_id":{"description":"The id of the inspection that this list belongs to","example":6342,"type":"number"},"inspection_types":{"items":{"$ref":"#/components/schemas/InspectionType"},"type":"array"},"is_deleted":true,"items":{"items":{"$ref":"#/components/schemas/ListItem"},"type":"array"},"name":{"description":"The auto-generated name of the list.","example":"List for Inspection 3527","type":"string"},"organization_id":{"description":"The id of the organization that this list belongs to","example":52,"type":"number"},"team_id":{"description":"The id of the team that this list belongs to","example":66,"type":"number"},"type":{"$ref":"#/components/schemas/ListType","description":"The type of the list. Must be `EVENT_TEMPLATE`, `EVENT_INSTANCE`, `SURVEY_TEMPLATE`, or `SURVEY_INSTANCE`","example":"EVENT_TEMPLATE"},"updated_at":{"description":"The date/time the resource was last updated","example":"2020-05-01T21:44:40.000Z","format":"date-time","type":"string"}},"required":["created_at","id","inspection_types","is_deleted","items","name","organization_id","type","updated_at"],"type":"object"},"list_id":{"description":"The id of the list that is used by this inspection type. References `lists.id`","example":3345,"type":"number"},"max_distance_from_address_threshold":{"description":"the maximum distance away from the configured inspection address that an inspection can be completed in meters.","example":1000,"type":"number"},"message_template_set":{"$ref":"#/components/schemas/MessageTemplateSet","description":"The message template set associated with this Inspection Type"},"message_template_set_id":{"description":"The id of the message template set that is used by this inspection type. References `message_template_sets.id`","example":539,"type":"number"},"modified_by_member_user_id":{"description":"the id of the user who last modified this inspection type. References `users.id`","example":2343,"type":"number"},"name":{"description":"The name of the inspection type","example":"My Type","type":"string"},"organization_id":{"description":"the id of the organization that this inspection type belongs to. References `organizations.id`.","example":14,"type":"number"},"outcome_set":{"$ref":"#/components/schemas/OutcomeSet","description":"The outcome set that is used by this inspection type."},"outcome_set_id":{"description":"The id of the outcome set that is used by this inspection type. References `outcome_sets.id`","example":539,"type":"number"},"team_id":{"deprecated":true,"description":"the id of the team that this inspection type belongs to. References `teams.id`. Note that this is no longer used, and inspection types can now be associated with multiple teams","example":124,"type":"number"},"teams":{"description":"The the teams that use this inspection type.","items":{"additionalProperties":false,"properties":{"id":{"description":"The id of the resource","example":1843,"type":"number"},"name":{"description":"The name of the team.","example":"Claims","type":"string"}},"required":["id"],"type":"object"},"type":"array"},"updated_at":{"description":"The date/time the resource was last updated","example":"2020-05-01T21:44:40.000Z","format":"date-time","type":"string"},"use_single_name_field":{"description":"When true, there is only one name for the user to fill out rather than a separate first name and last name field","example":true,"type":"boolean"}},"required":["created_at","custom_fields","id","is_address_required","is_deleted","is_list_locked","language","list","message_template_set","message_template_set_id","name","organization_id","team_id","updated_at","use_single_name_field"],"type":"object"},"type":"array"},"is_deleted":true,"jwt_agent_admin_expiry":{"default":"72h","description":"The amount of time before an admin member's login token when switching teams expires. Any format supported by https://github.com/vercel/ms is valid.","example":"10h","type":"string"},"jwt_customer_expiry":{"default":"480h","description":"The amount of time before an inspection request token expires. Any format supported by https://github.com/vercel/ms is valid.","example":"120h","type":"string"},"list":{"items":{"additionalProperties":false,"description":"A list with attached list items and or inspection types","properties":{"created_at":{"description":"The date/time the resource was created","example":"2020-05-01T21:44:40.000Z","format":"date-time","type":"string"},"created_by_member_user_id":{"description":"The id of the user that created this list","example":609,"type":"number"},"groups":{"$ref":"#/components/schemas/ListItemGroups","description":"The groups of items in the list","example":{"grp1":{"name":"Group 2"}}},"id":{"description":"The id of the resource.","example":1843,"type":"number"},"inspection_id":{"description":"The id of the inspection that this list belongs to","example":6342,"type":"number"},"inspection_types":{"items":{"$ref":"#/components/schemas/InspectionType"},"type":"array"},"is_deleted":true,"items":{"items":{"$ref":"#/components/schemas/ListItem"},"type":"array"},"name":{"description":"The auto-generated name of the list.","example":"List for Inspection 3527","type":"string"},"organization_id":{"description":"The id of the organization that this list belongs to","example":52,"type":"number"},"team_id":{"description":"The id of the team that this list belongs to","example":66,"type":"number"},"type":{"$ref":"#/components/schemas/ListType","description":"The type of the list. Must be `EVENT_TEMPLATE`, `EVENT_INSTANCE`, `SURVEY_TEMPLATE`, or `SURVEY_INSTANCE`","example":"EVENT_TEMPLATE"},"updated_at":{"description":"The date/time the resource was last updated","example":"2020-05-01T21:44:40.000Z","format":"date-time","type":"string"}},"required":["created_at","id","inspection_types","is_deleted","items","name","organization_id","type","updated_at"],"type":"object"},"type":"array"},"name":{"description":"The name of the team.","example":"Claims","type":"string"},"notify_inspection_creator":{"description":"Whether to notify the member who created the inspection request of updates.","enum":[1,0],"example":1,"type":"number"},"organization_id":{"description":"The id of the organization this team belongs to.","example":123,"type":"number"},"phone_numbers":{"additionalProperties":{"type":"string"},"type":"object"},"ready_for_review_recipients":{"description":"A comma-separated list of email addresses to notify of inspection request updates.","example":"team@qualitylending.com,support@qualitylending.com","type":"string"},"send_methods":{"additionalProperties":false,"description":"The default methods to send the inspection request to the customer who will be completing the inspection.","properties":{"email":{"description":"Whether to send the inspection request via email.","example":true,"type":"boolean"},"text":{"description":"Whether to send the inspection request via text.","example":true,"type":"boolean"}},"required":["text","email"],"type":"object"},"send_methods_allowed":{"additionalProperties":false,"description":"This is an optional object specifying which send methods are allowed, all sending methods cannot all be disallowed","properties":{"email":{"default":true,"description":"Whether sending an inspection by email is allowed or not.","example":true,"type":"boolean"},"text":{"default":true,"description":"Whether sending an inspection by text message is allowed or not.","example":true,"type":"boolean"}},"required":["text","email"],"type":"object"},"shortname":{"description":"The combined URL-friendly name of the organization and team.","example":"quality-capital-claims","type":"string"},"slug":{"description":"The URL-friendly name of the team.","example":"claims","type":"string"},"status_callback_url":{"description":"The callback URL we send a request to on action / change in status of an inspection request","example":"https://api.qualitycapital.com/hooks/truepic","type":"string"},"theme_slug":{"description":"The url slug used to acquire the team's assets","example":"coca-cola","type":"string"},"updated_at":{"description":"The date/time the resource was last updated","example":"2020-05-01T21:44:40.000Z","format":"date-time","type":"string"},"video_enabled":true},"required":["organization_id","is_deleted","jwt_organization_expiry","jwt_member_admin_expiry","shortname","created_at","updated_at","inspection_types"],"type":"object"}},"required":["api_version","message","response_code","result"],"type":"object"},"GetTeamWebhookResult":{"additionalProperties":false,"properties":{"api_version":{"description":"The current version number of the Vision API","example":"3.0.0","type":"string"},"message":{"description":"The human readable-status of the response","example":"Success","type":"string"},"response_code":{"description":"The HTTP status code of the response","example":200,"type":"integer"},"result":{"$ref":"#/components/schemas/TeamWebhookResponse"}},"required":["api_version","message","response_code","result"],"type":"object"},"GetTeamWebhooksResult":{"additionalProperties":false,"properties":{"api_version":{"description":"The current version number of the Vision API","example":"3.0.0","type":"string"},"message":{"description":"The human readable-status of the response","example":"Success","type":"string"},"pageCount":{"description":"The total number of pages for the given query","example":12,"type":"number"},"response_code":{"description":"The HTTP status code of the response","example":200,"type":"integer"},"result":{"description":"A paginated list of team webhooks","items":{"$ref":"#/components/schemas/TeamWebhookResponse"},"type":"array"},"total":{"description":"The total number of results for the given page","example":25,"type":"number"},"totalResults":{"description":"The total number of results for the given query","example":251,"type":"number"}},"required":["api_version","message","pageCount","response_code","result","total","totalResults"],"type":"object"},"GetTeamsResult":{"additionalProperties":false,"properties":{"api_version":{"description":"The current version number of the Vision API","example":"3.0.0","type":"string"},"message":{"description":"The human readable-status of the response","example":"Success","type":"string"},"pageCount":{"description":"The total number of pages for the given query","example":12,"type":"number"},"response_code":{"description":"The HTTP status code of the response","example":200,"type":"integer"},"result":{"description":"A paginated list of Teams with group information","items":{"$ref":"#/components/schemas/PopulatedTeam"},"type":"array"},"total":{"description":"The total number of results for the given page","example":25,"type":"number"},"totalResults":{"description":"The total number of results for the given query","example":251,"type":"number"}},"required":["api_version","message","pageCount","response_code","result","total","totalResults"],"type":"object"},"GetTextMatchingSetResult":{"additionalProperties":false,"properties":{"api_version":{"description":"The current version number of the Vision API","example":"3.0.0","type":"string"},"message":{"description":"The human readable-status of the response","example":"Success","type":"string"},"response_code":{"description":"The HTTP status code of the response","example":200,"type":"integer"},"result":{"$ref":"#/components/schemas/PopulatedTextMatchingSet"}},"required":["api_version","message","response_code","result"],"type":"object"},"GetTextMatchingSetsResult":{"additionalProperties":false,"properties":{"api_version":{"description":"The current version number of the Vision API","example":"3.0.0","type":"string"},"message":{"description":"The human readable-status of the response","example":"Success","type":"string"},"pageCount":{"description":"The total number of pages for the given query","example":12,"type":"number"},"response_code":{"description":"The HTTP status code of the response","example":200,"type":"integer"},"result":{"items":{"$ref":"#/components/schemas/PopulatedTextMatchingSet"},"type":"array"},"total":{"description":"The total number of results for the given page","example":25,"type":"number"},"totalResults":{"description":"The total number of results for the given query","example":251,"type":"number"}},"required":["api_version","message","pageCount","response_code","result","total","totalResults"],"type":"object"},"GetUnsubscribedEmailsResult":{"additionalProperties":false,"description":"Response Body for GET /emails/unsubscribed-email","properties":{"api_version":{"description":"The current version number of the Vision API","example":"3.0.0","type":"string"},"message":{"description":"The human readable-status of the response","example":"Success","type":"string"},"pageCount":{"description":"The total number of pages for the given query","example":12,"type":"number"},"response_code":{"description":"The HTTP status code of the response","example":200,"type":"integer"},"result":{"description":"A paginated list of emails","items":{"$ref":"#/components/schemas/UnsubscribedEmail"},"type":"array"},"total":{"description":"The total number of results for the given page","example":25,"type":"number"},"totalResults":{"description":"The total number of results for the given query","example":251,"type":"number"}},"required":["api_version","message","pageCount","response_code","result","total","totalResults"],"type":"object"},"GetUserResult":{"additionalProperties":false,"description":"Response Body for GET /users/{userId}","properties":{"api_version":{"description":"The current version number of the Vision API","example":"3.0.0","type":"string"},"message":{"description":"The human readable-status of the response","example":"Success","type":"string"},"response_code":{"description":"The HTTP status code of the response","example":200,"type":"integer"},"result":{"$ref":"#/components/schemas/SerializedUser"}},"required":["api_version","message","response_code","result"],"type":"object"},"GetUserSupportResult":{"additionalProperties":false,"description":"The response body for GET /auth/user/support","properties":{"api_version":{"description":"The current version number of the Vision API","example":"3.0.0","type":"string"},"message":{"description":"The human readable-status of the response","example":"Success","type":"string"},"response_code":{"description":"The HTTP status code of the response","example":200,"type":"integer"},"result":{"additionalProperties":false,"properties":{"user_jwt":{"description":"The user JWT for securing the Intercom messenger.","type":"string"}},"required":["user_jwt"],"type":"object"}},"required":["api_version","message","response_code","result"],"type":"object"},"GetUsersResult":{"additionalProperties":false,"description":"Response Body for GET /users","properties":{"api_version":{"description":"The current version number of the Vision API","example":"3.0.0","type":"string"},"message":{"description":"The human readable-status of the response","example":"Success","type":"string"},"pageCount":{"description":"The total number of pages for the given query","example":12,"type":"number"},"response_code":{"description":"The HTTP status code of the response","example":200,"type":"integer"},"result":{"description":"A paginated list of users","items":{"$ref":"#/components/schemas/SerializedUser"},"type":"array"},"total":{"description":"The total number of results for the given page","example":25,"type":"number"},"totalResults":{"description":"The total number of results for the given query","example":251,"type":"number"}},"required":["api_version","message","pageCount","response_code","result","total","totalResults"],"type":"object"},"GetWebsiteFormBearerResult":{"additionalProperties":false,"properties":{"api_version":{"description":"The current version number of the Vision API","example":"3.0.0","type":"string"},"message":{"description":"The human readable-status of the response","example":"Success","type":"string"},"response_code":{"description":"The HTTP status code of the response","example":200,"type":"integer"},"result":{"additionalProperties":false,"properties":{"inspection_types":{"items":{"additionalProperties":false,"properties":{"custom_fields":{"description":"An array of custom fields that are used by this inspection type","items":{"$ref":"#/components/schemas/CustomField"},"type":"array"},"id":{"description":"The id of the inspection type","example":1843,"type":"number"},"is_address_required":{"description":"Controls whether an address is required for the inspection or not","example":1000,"type":"boolean"},"name":{"description":"The name of the inspection type","example":"My Type","type":"string"},"use_single_name_field":{"description":"When true, there is only one name for the user to fill out rather than a separate first name and last name field","example":true,"type":"boolean"}},"required":["id","name","use_single_name_field","is_address_required","custom_fields"],"type":"object"},"type":"array"},"is_email_required":{"description":"Whether the email field is required on the website form. Defaults to `false`.","example":false,"type":"boolean"},"is_phone_required":{"description":"Whether the phone field is required on the website form. Defaults to `false`.","example":false,"type":"boolean"},"should_show_address":{"description":"Whether the address field should be shown on the website form when it is optional. The field is always shown if it is required by the inspection type. Defaults to `false`.","example":false,"type":"boolean"},"token":{"description":"The unique token used by the website form to authenticate with the API.","example":"-SQuSE62r4ISFCE4EOOTtu3yx1SW8i6PE7VMZwvVZ8TNyliC","type":"string"}},"required":["inspection_types","is_email_required","is_phone_required","should_show_address","token"],"type":"object"}},"required":["api_version","message","response_code","result"],"type":"object"},"GetWebsiteFormResult":{"additionalProperties":false,"properties":{"api_version":{"description":"The current version number of the Vision API","example":"3.0.0","type":"string"},"message":{"description":"The human readable-status of the response","example":"Success","type":"string"},"response_code":{"description":"The HTTP status code of the response","example":200,"type":"integer"},"result":{"$ref":"#/components/schemas/WebsiteFormSerializedWithInspectionTypeIds"}},"required":["api_version","message","response_code","result"],"type":"object"},"GetWebsiteFormsResult":{"additionalProperties":false,"properties":{"api_version":{"description":"The current version number of the Vision API","example":"3.0.0","type":"string"},"message":{"description":"The human readable-status of the response","example":"Success","type":"string"},"pageCount":{"description":"The total number of pages for the given query","example":12,"type":"number"},"response_code":{"description":"The HTTP status code of the response","example":200,"type":"integer"},"result":{"items":{"$ref":"#/components/schemas/WebsiteFormSerialized"},"type":"array"},"total":{"description":"The total number of results for the given page","example":25,"type":"number"},"totalResults":{"description":"The total number of results for the given query","example":251,"type":"number"}},"required":["api_version","message","pageCount","response_code","result","total","totalResults"],"type":"object"},"Group":{"additionalProperties":false,"description":"A group of users (self initiated inspectors) who can login to the app to create and perform inspections.","properties":{"address":{"description":"The address of the group","example":"7817 Ivanhoe Avenue, La Jolla, CA 92037","type":"string"},"created_at":{"description":"The date/time the resource was created","example":"2020-05-01T21:44:40.000Z","format":"date-time","type":"string"},"created_by_user_id":{"description":"The id of the user that creted the group","example":551,"type":"number"},"id":{"description":"The id of the resource.","example":1843,"type":"number"},"name":{"description":"The name of the group","example":"Acura of La Jolla","type":"string"},"updated_at":{"description":"The date/time the resource was last updated","example":"2020-05-01T21:44:40.000Z","format":"date-time","type":"string"}},"required":["created_at","created_by_user_id","id","name","updated_at"],"type":"object"},"Inspection":{"additionalProperties":false,"description":"The core resource representing an inspection request","properties":{"address":{"description":"The physical address where the inspection is expected to take place","example":"532 Mission Street, Santa Clara, CA, USA","format":"address","type":"string"},"address_lat":{"description":"The latitude of `address` if set, otherwise `null`.","example":"40.0612708","type":"string"},"address_lng":{"description":"The longitude of `address` if set, otherwise `null`.","example":"40.0612708","type":"string"},"ai_status":{"$ref":"#/components/schemas/VerificationResult","description":"The AI analysis result for this inspection.","example":"pass"},"ai_status_details":{"$ref":"#/components/schemas/AIStatusDetails","description":"The details of the AI status for this inspection. This may include information about the criteria evaluation, any inconsistencies detected, and more."},"ai_status_reason":{"$ref":"#/components/schemas/AIStatusReason","description":"The reason for the AI analysis result for this inspection.","example":"COMPLETE_WITH_NO_INCONSISTENCIES"},"app_opened":true,"assigned_to_member_user_id":{"description":"The id of the user this inspection is assigned to.","example":19,"type":"number"},"created_at":{"description":"The date/time the resource was created","example":"2020-05-01T21:44:40.000Z","format":"date-time","type":"string"},"created_by_member_user_id":{"description":"The id of the member that created this inspection.","example":43,"type":"number"},"custom_field_values":{"description":"The values for the custom fields defined in the inspection type. The order of the values must match the order of the custom fields defined in the inspection type.  If the value is optional then you can provide null for that value.","example":["abc123","def123"],"items":{"type":"string"},"type":"array"},"customer_email_address":{"description":"The email address of the customer completing the inspection. Required if `send_methods.email` is `true`.","example":"kylorenxninja@gmail.com","format":"email","maxLength":255,"type":"string"},"customer_first_name":{"description":"The first name of the customer completing the inspection.","example":"Kylo","maxLength":255,"type":"string"},"customer_ip_address":{"description":"The IP address of the customer, recorded during the most recent photo capture inspection.","example":"123.532.124.174","format":"ipv4, ipv6","maxLength":255,"type":"string"},"customer_last_name":{"description":"The last name of the customer completing the inspection.","example":"Ren","maxLength":255,"type":"string"},"customer_name":{"description":"The full name of the customer who will be completing the inspection. If specified, then `customer_first_name` and `customer_last_name` will not be provided.","example":"Kylo Ren","maxLength":255,"type":"string"},"customer_phone_country":{"description":"The country code for the customer's phone number.","example":"US","maxLength":2,"type":"string"},"customer_phone_number":{"description":"The mobile number of the customer completing the inspection. Required if `send_methods.text` is `true`.","example":"3028675309","format":"phone","pattern":"/^[\\d]{10}$/","type":"string"},"deleted_at":{"description":"The date/time the inspection was deleted. `null` if not deleted.","example":"2020-05-01T21:44:40.000Z","format":"date-time","type":"string","nullable":true},"deleted_by_user_id":{"description":"The ID of the user who deleted the inspection. `null` if not deleted or auto-deleted by the system.","example":19,"type":"number","nullable":true},"email_auto_reply_sent":{"description":"The datetime an email automated reply was sent","example":"2023-01-04 15:11:39.642","format":"date-time","type":"string"},"group_id":{"description":"The id of the group this inspection is for.","example":23,"type":"number"},"id":{"description":"The id of the inspection request","example":1843,"type":"number"},"inspection_link":{"description":"A smart link to load the inspection in the Vision app. This link is generated by the Vision backend and is unique to the inspection.","example":"visionbytruepic.com/23AUkqg1xRb","type":"string"},"inspection_ready_criteria_text":{"description":"Free-form inspection-ready criteria text. Max length 10KB.","example":"Capture all rooms and appliances.","maxLength":10240,"type":"string","nullable":true},"inspection_status_id":{"$ref":"#/components/schemas/InspectionStatusId","description":"The id of the inspection status this inspection is in.","example":4},"inspection_type_id":{"description":"The id of the inspection type this inspection is for.","example":12,"type":"number"},"is_deleted":true,"is_expired":true,"max_distance_from_address_threshold":{"description":"The maximum distance, in meters, from the address that the photos/videos must be taken in order to be valid","example":1000,"type":"integer"},"message_supplement":{"description":"The message supplement (custom note) to be attached to the request text/email. Maximum length of 255 characters.","example":"Please complete in a timely manner","maxLength":255,"type":"string"},"organization_id":{"description":"The id of the organization this inspection is for.","example":117,"type":"number"},"outcome_id":{"description":"The id of the outcome of this inspection.","example":29,"type":"number"},"outcome_reason":{"description":"The reason for the outcome of this inspection","example":"Customer cancelled their service with our company","type":"string"},"photo_uploaded_at":{"description":"The date/time when the last photo/video was uploaded. ISO 8601 format.","example":"2020-05-01T21:44:40.000Z","format":"date-time","type":"string"},"platform":{"$ref":"#/components/schemas/InspectionPlatform","description":"The platform of our app that the inspection will be / has been performed on."},"scheduled_for":{"description":"The date/time (in UTC) the inspection is scheduled to be sent to the customer","example":"2020-05-01T21:44:40.000Z","format":"date-time","type":"string"},"scheduled_tz":{"description":"The IANA timezone name for the inspection's scheduled datetime. Used only for display purposes, as `scheduled_for` is in UTC.","example":"America/New_York","type":"string"},"send_methods":{"additionalProperties":false,"description":"The method(s) to send the inspection request to the customer completing the inspection.","properties":{"email":{"description":"When true, will send text messages to the customer_email_address","example":false,"type":"boolean"},"text":{"description":"When true, will send text messages to the customer_phone_number","example":true,"type":"boolean"}},"required":["text","email"],"type":"object"},"sent_auto_finish_reminders":{"description":"Times to send automated finish reminders","example":["10m","20m","30m"],"items":{"type":"string"},"type":"array"},"sent_auto_reminders":{"description":"Times to send automated reminders","example":["10m","20m","30m"],"items":{"type":"string"},"type":"array"},"sms_auto_reply_sent":{"description":"The datetime an sms automated reply was sent","example":"2023-01-04 15:11:39.642","format":"date-time","type":"string"},"team_id":{"description":"The id of the team this inspection is for.","example":182,"type":"number"},"updated_at":{"description":"The date/time the resource was last updated","example":"2020-05-01T21:44:40.000Z","format":"date-time","type":"string"},"verification_result":{"$ref":"#/components/schemas/VerificationResult","description":"The aggregate verification result of all photos/videos","example":"pass"}},"required":["app_opened","assigned_to_member_user_id","created_at","created_by_member_user_id","custom_field_values","id","inspection_status_id","inspection_type_id","is_deleted","is_expired","organization_id","send_methods","team_id","updated_at"],"type":"object"},"InspectionAlertConfig":{"additionalProperties":false,"description":"An alert configuration for an organization. Notifies an organization when an list items on an inspection do not pass the configured tests.","properties":{"created_at":{"description":"The date/time the resource was created","example":"2020-05-01T21:44:40.000Z","format":"date-time","type":"string"},"created_by_user_id":{"description":"The id of the user that created the alert.","example":123,"type":"number"},"fail_threshold":{"description":"The number of tests that need to fail for this alert to be triggered with a \"fail\" recommendation.","example":3,"type":"number"},"id":{"description":"The id of the resource.","example":1843,"type":"number"},"is_deleted":true,"modified_by_user_id":{"description":"The id of the user that last edited the alert.","example":124,"type":"number"},"name":{"description":"The name of the alert.","example":"Risk Detection Alert","maxLength":255,"type":"string"},"organization_id":{"description":"The id of the organization.","example":531,"type":"number"},"test_blurriness":{"description":"Whether or not to include the blurriness test in this alert.","example":true,"type":"boolean"},"test_capture_integrity":{"description":"Whether or not to include the capture integrity test in this alert.","example":true,"type":"boolean"},"test_content_analysis_dot_tin":{"default":true,"description":"Whether or not to include the DOT TIN test in this alert.","example":true,"type":"boolean"},"test_content_analysis_odometer":{"description":"Whether or not to include the odometer test in this alert.","example":true,"type":"boolean"},"test_content_analysis_text_matching":{"description":"Whether or not to include the odometer test in this alert.","example":true,"type":"boolean"},"test_content_analysis_vin":{"description":"Whether or not to include the VIN test in this alert.","example":true,"type":"boolean"},"test_datetime":{"description":"Whether or not to include the datetime test in this alert.","example":true,"type":"boolean"},"test_device_flagged":{"default":true,"description":"Whether or not to include the device flagged test in this alert.","example":true,"type":"boolean"},"test_device_found_other_inspections":{"default":true,"description":"Whether or not to include the device found in other inspections test in this alert.","example":true,"type":"boolean"},"test_device_integrity":{"description":"Whether or not to include the device integrity test in this alert.","example":true,"type":"boolean"},"test_distance_from_address":{"description":"Whether or not to include the distance-from-address test in this alert.","example":true,"type":"boolean"},"test_falsified_location":{"default":true,"description":"Whether or not to include the falsified location test in this alert.","example":true,"type":"boolean"},"test_geolocation":{"description":"Whether or not to include the geolocation test in this alert.","example":true,"type":"boolean"},"test_insecure_device":{"default":true,"description":"Whether or not to include the jailbroken or rooted device test in this alert.","example":true,"type":"boolean"},"test_object_detection":{"default":true,"description":"Whether or not to include the object detection test in this alert.","example":true,"type":"boolean"},"test_pop":{"description":"Whether or not to include the pop test in this alert.","example":true,"type":"boolean"},"test_ris":{"description":"Whether or not to include the ris test in this alert.","example":true,"type":"boolean"},"updated_at":{"description":"The date/time the resource was last updated","example":"2020-05-01T21:44:40.000Z","format":"date-time","type":"string"},"warn_threshold":{"description":"The number of tests that need to have warnings for this alert to be triggered with a \"warn\" recommendation.","example":3,"type":"number"}},"required":["created_at","created_by_user_id","fail_threshold","id","is_deleted","name","organization_id","test_blurriness","test_capture_integrity","test_content_analysis_dot_tin","test_content_analysis_odometer","test_content_analysis_text_matching","test_content_analysis_vin","test_datetime","test_device_integrity_flagged","test_device_integrity_found_other_inspections","test_device_integrity_integrity","test_distance_from_address","test_falsified_location","test_geolocationlocation","test_insecure_device","test_object_detection","test_pop","test_ris","updated_at","warn_threshold"],"type":"object"},"InspectionAlertResult":{"additionalProperties":false,"properties":{"config":{"$ref":"#/components/schemas/InspectionAlertConfig"},"failures":{"items":{"$ref":"#/components/schemas/AlertTrigger"},"type":"array"},"recommendation":{"$ref":"#/components/schemas/VerificationResult"},"warnings":{"items":{"$ref":"#/components/schemas/AlertTrigger"},"type":"array"}},"required":["config","warnings","failures","recommendation"],"type":"object"},"InspectionDeviceInfo":{"additionalProperties":false,"properties":{"created_at":{"description":"The date/time the resource was created","example":"2020-05-01T21:44:40.000Z","format":"date-time","type":"string"},"device":{"description":"The device model, as returned by the device fingerprinting service.","example":"iPhone 12","type":"string"},"fingerprint_id":{"description":"The Fingerprint ID of the device, as returned by the device fingerprinting service.","example":"Y7k0XNpijpaOjbQ0Yyzq","type":"string"},"flags":{"description":"The current list of flags on this device for this inspection.","items":{"$ref":"#/components/schemas/DeviceFlagType"},"type":"array"},"flags_other_inspections":{"additionalProperties":false,"description":"A list of flags on this device for other inspections in your organization.","properties":{"flag_counts":{"additionalProperties":false,"description":"The count of for each flag type on this device for other organizations.","properties":{"bad_answer":{"type":"number"},"bad_photo":{"type":"number"},"deleted_photos":{"type":"number"},"falsified_time":{"type":"number"},"incorrect_location":{"type":"number"},"other":{"type":"number"},"picture_of_photo":{"type":"number"},"rooted_device":{"type":"number"},"spoofed_location":{"type":"number"}},"type":"object"},"inspections":{"items":{"additionalProperties":false,"properties":{"assigned_to_member_user_id":{"description":"The user ID of the user this inspection is assigned to","type":"number"},"first_flagged":{"description":"The date that this device was first flagged in the inspection.","example":"2020-05-01T21:44:40.000Z","type":"string"},"inspection_id":{"description":"The ID of the inspection where this device was flagged","type":"number"},"team_id":{"description":"The ID of the team this inspection is assigned to","type":"number"}},"required":["inspection_id","team_id","assigned_to_member_user_id","first_flagged"],"type":"object"},"type":"array"}},"type":"object"},"flags_other_orgs":{"additionalProperties":false,"description":"The count of for each flag type on this device for other organizations.","properties":{"first_flagged_dates":{"description":"The dates that this device was flagged in other organization's inspections. Each date refers to the first time this device was flagged in a single inspection.","example":["2020-05-01T21:44:40.000Z"],"items":{"type":"string"},"type":"array"},"flag_counts":{"additionalProperties":false,"description":"The count of for each flag type on this device for other organizations.","properties":{"bad_answer":{"type":"number"},"bad_photo":{"type":"number"},"deleted_photos":{"type":"number"},"falsified_time":{"type":"number"},"incorrect_location":{"type":"number"},"other":{"type":"number"},"picture_of_photo":{"type":"number"},"rooted_device":{"type":"number"},"spoofed_location":{"type":"number"}},"type":"object"},"org_count":{"example":5,"type":"number"}},"type":"object"},"id":{"description":"The id of the device record.","example":1843,"type":"number"},"last_seen_at":{"description":"The date and time when the device was last seen by the system.","example":"2023-10-01T12:00:00Z","type":"string"},"os":{"description":"The operating system of the device, as returned by the device fingerprinting service.","example":"iOS","type":"string"},"os_version":{"description":"The version of the operating system of the device, as returned by the device fingerprinting service.","example":"14.4","type":"string"},"other_inspections":{"description":"A list of other inspections this device was used in","items":{"additionalProperties":false,"properties":{"assigned_to_member_user_id":{"description":"The user ID of the member assigned to the inspection","type":"number"},"id":{"description":"The ID of the inspection","type":"number"},"team_id":{"description":"The team ID of the inspection","type":"number"}},"required":["id","team_id","assigned_to_member_user_id"],"type":"object"},"type":"array"},"updated_at":{"description":"The date/time the resource was last updated","example":"2020-05-01T21:44:40.000Z","format":"date-time","type":"string"}},"required":["created_at","device","fingerprint_id","id","last_seen_at","os","os_version","other_inspections","updated_at"],"type":"object"},"InspectionInsightType":{"enum":["insecure_device","falsified_location","device_found_other_inspections","device_flagged_other_inspections"],"type":"string"},"InspectionListItemWithPhotos":{"additionalProperties":false,"properties":{"accept_existing_images":{"description":"Whether or not to accept existing images for this list item.","example":false,"type":"boolean"},"ai_analysis_set_id":{"description":"The id of the AI Analysis Set used for Vision AI Analysis. References `ai_analysis_sets.id`","example":3,"type":"number","nullable":true},"capture_max":{"description":"Limit the number of images taken for this list item. Must be positive number","example":11,"type":"number"},"condition_id":{"description":"A unique identifier used to create conditional list items in conjunction with the `conditions` field on another list item. It's best to generate a unique value for this field.","maxLength":255,"type":"string"},"conditions":{"description":"An array mapping answers to conditions. Use this field in conjunction with the `condition_id` on another list item (the \"parent\" item) to make this item (the \"child\" item) only appear when a specific answer is given on the parent item. Up to 5 layers of nested conditional items can be created.","items":{"additionalProperties":false,"properties":{"id":{"description":"The condition_id of the \"parent\" list item that this list item is triggered by.","type":"string"},"question":{"additionalProperties":false,"properties":{"answer":{"description":"The answer that triggers the associated condition","type":"string"}},"required":["answer"],"type":"object"}},"required":["id","question"],"type":"object"},"type":"array"},"content_analysis":{"$ref":"#/components/schemas/ContentAnalysisResultDetails"},"created_at":{"description":"The date/time the resource was created","example":"2020-05-01T21:44:40.000Z","format":"date-time","type":"string"},"created_by_member_user_id":{"description":"The id of the member that created this list item.","example":634,"type":"number"},"custom_data":{"additionalProperties":{},"description":"Any additional data that should be stored with the list item.","example":{"key":"value"},"maxLength":1000,"type":"object"},"example_photo":{"description":"The url location of the example photo for the list item. Note: you cannot have both an example photo and an example video.","type":"string"},"example_photo_square":{"description":"The url location of the square example photo (thumbnail) for the list item.","type":"string"},"example_video":{"description":"The url location of the example video for the list item. This must be a valid YouTube or Vimeo URL embedding URL. Note: you cannot have both an example video and an example photo.","type":"string"},"expected_required":{"description":"Indicates whether or not an `expected` criteria needs to be entered at the time the inspection is sent.","example":true,"type":"boolean"},"group_id":{"description":"The id of the group that this list item is associated with.","example":1256,"type":"string"},"id":{"description":"The id of the resource.","example":1843,"type":"number"},"incomplete_at":{"description":"The timestamp when the list item was marked as incomplete.","type":"string"},"is_deleted":true,"is_required":true,"list_id":{"description":"The id of the list that is item is associated with.","example":1256,"type":"number"},"name":{"description":"A description of the requested photo or video when `type` is `IMAGE`, `PHOTO`, or `VIDEO`. A question for the customer to answer when `type` is `QUESTION`. The customer will see this value in the Vision app during the inspection.","example":"Front of car","maxLength":1500,"type":"string"},"object_detection":{"$ref":"#/components/schemas/ObjectDetectionConfig","description":"An object containing information about the expected items in a Truepic."},"order":{"description":"The numerical order of the list item within the list. Starts at `1`.","example":1,"type":"number"},"photos":{"items":{"$ref":"#/components/schemas/InspectionTruepic"},"type":"array"},"question":{"additionalProperties":false,"properties":{"answer":{"anyOf":[{"anyOf":[{"nullable":true},{"items":{"additionalProperties":false,"properties":{"custom":{"description":"The user's custom text answer. Used for answer options where `allow_custom` is `true`","type":"string"},"name":{"description":"A selected answer to the question.","example":"Excellent","type":"string"}},"required":["name"],"type":"object"},"type":"array"}],"description":"The answer(s) selected by the user, or null if unanswered"},{"description":"The user's text answer, or null if unanswered","type":"string","nullable":true},{"description":"The user's date answer as a string, or null if unanswered","type":"string","nullable":true}],"description":"The answer(s) selected by the user, or null if unanswered"}},"type":"object"},"type":{"$ref":"#/components/schemas/ListItemType","description":"The type of the list item."},"updated_at":{"description":"The date/time the resource was last updated","example":"2020-05-01T21:44:40.000Z","format":"date-time","type":"string"}},"required":["content_analysis","created_at","created_by_member_user_id","id","is_deleted","is_required","list_id","name","photos","type","updated_at"],"type":"object"},"InspectionPlatform":{"description":"The platform of our app that the inspection will be / has been performed on.","enum":["native","web"],"type":"string"},"InspectionStatus":{"additionalProperties":false,"description":"A type of action that can occur an inspection.","properties":{"created_at":{"description":"The date/time the resource was created","example":"2020-05-01T21:44:40.000Z","format":"date-time","type":"string"},"id":{"description":"The id of the resource.","example":1843,"type":"number"},"id_internal":{"description":"The code-parseable identifier of the status.","example":"STATUS_READY_FOR_REVIEW","type":"string"},"name":{"description":"The human-readable name of the status.","example":"Ready for Review","type":"string"},"updated_at":{"description":"The date/time the resource was last updated","example":"2020-05-01T21:44:40.000Z","format":"date-time","type":"string"}},"required":["created_at","id","updated_at"],"type":"object"},"InspectionStatusId":{"description":"The possible statuses for an inspection.","enum":[1,2,3,4,5,6,7],"type":"number"},"InspectionTruepic":{"additionalProperties":false,"properties":{"accuracy":{"description":"The accuracy of the GPS coordinates in meters.","example":165,"type":"number"},"ai_analysis_done":{"description":"Whether the AI analysis test is complete for this Truepic.","example":true,"type":"boolean"},"ai_analysis_status":{"$ref":"#/components/schemas/TestResult","description":"The status of an AI analysis test on this Truepic.","example":"P"},"archived":true,"blockchain_status":{"$ref":"#/components/schemas/TestResult","description":"The status of a blockchain test on this Truepic.","example":"P"},"capture_integrity_status":{"$ref":"#/components/schemas/TestResult","description":"The status of a capture integrity test on this Truepic.","example":"P"},"city":{"description":"The city where the photo/video was taken, based on GPS coordinates.","example":"La Jolla","type":"string"},"comment":{"description":"The comment attached to the Truepic","example":"Hello","type":"string"},"container_id":{"description":"The id of the container this Truepic is part of","example":10,"type":"number"},"content_analysis_status":{"$ref":"#/components/schemas/TestResult","description":"The status of a content analysis test on this Truepic.","example":"P"},"created_at":{"description":"The date/time the resource was created","example":"2020-05-01T21:44:40.000Z","format":"date-time","type":"string"},"datetime_status":{"$ref":"#/components/schemas/TestResult","description":"The status of a datetime test on this Truepic.","example":"P"},"device_fingerprint_id":{"description":"The ID from the Fingerprint service to identify the device that took the photo","type":"string"},"device_id":{"description":"The ID of the device that took the photo","type":"number"},"device_integrity_status":{"$ref":"#/components/schemas/TestResult","description":"The status of a device integrity test on this Truepic.","example":"P"},"device_time":{"description":"The date/time of the device when the photo/video was captured. ISO 8601 format.","example":"2018-08-06T15:29:47.000Z","format":"date-time","type":"string"},"distance_from_customer_address":{"type":"number"},"distance_from_customer_address_exceeds_threshold":{"type":"boolean"},"duration":{"description":"The video duration of this Truepic, if it is a video.","example":"0:00:30","type":"string"},"formatted_address":{"description":"The formatted address where the photo/video was taken, based on GPS coordinates.","example":"7817 Ivanhoe Avenue, La Jolla, CA 92037","type":"string"},"geolocation_status":{"$ref":"#/components/schemas/TestResult","description":"The status of a geolocation test on this Truepic.","example":"P"},"gps_ts":{"description":"The unix timestamp of the GPS where the capture was taken.","example":"555262184.034417","type":"string"},"heading":{"description":"The direction the device was facing when the photo/video was taken. `0.0` is magnetic north.","example":220.48,"type":"number"},"id":{"description":"The id of the resource.","example":1843,"type":"number"},"image":{"description":"A URL to a scaled-down version of the image.","example":"https://d3tbfdtihunht2.cloudfront.net/qfzkoxugjn_f.jpg?...","type":"string"},"inspection_id":{"description":"The id of the inspection this Truepic is associated with.","example":6522,"type":"number"},"internal_note":{"description":"An internal note by a dashboard user attached to this Truepic","example":"Looks damaged.","type":"string"},"is_deleted":true,"is_rooted":true,"lat":{"description":"The GPS latitude where the photo/video was taken.","example":"33.5565051716316","type":"string"},"lens_transfer_done":true,"lng":{"description":"The GPS longitude where the photo/video was taken.","example":"33.5565051716316","type":"string"},"local_ts":{"description":"The localized timestamp of the capture of the Truepic","example":"6/14/23 4:02pm EDT","type":"string"},"make":{"description":"The make of the device that captured this Truepic","example":"Apple","type":"string"},"md5_hash":{"description":"The md5 hash of the Truepic signature","example":"900edbargawerfgaerwgd8a2c76ab2","type":"string"},"media_digest":{"description":"The media digest of the Truepic","example":"001183fw23f2w3fwergdsghr2q35aaada5wefw234f23rfw23wec13af441e6b","type":"string"},"model":{"description":"The model of the device that captured this Truepic","example":"iPhone 7","type":"string"},"object_detection_done":{"description":"Whether the object detection test is complete for this Truepic.","example":true,"type":"boolean"},"object_detection_status":{"$ref":"#/components/schemas/TestResult","description":"The status of an object detection test on this Truepic.","example":"P"},"original_image":{"description":"A URL to the original image.","example":"https://d3tbfdtihunht2.cloudfront.net/qfzkoxugjn_o.jpg?...","type":"string"},"os":{"description":"The version of the operating system that captured this Truepic","example":"11.4.1","type":"string"},"pending_upload":true,"photo_list_id":{"description":"The photo list id this Truepic is a part of","example":5678,"type":"number"},"pop_status":{"$ref":"#/components/schemas/TestResult","description":"The status of a picture-of-paper test on this Truepic.","example":"P"},"processing_completed_at":{"description":"The time at which all processing (RIS, Object Detection, Content Analysis, AI Analysis, etc) from Vision and Lens was completed. NULL if incomplete.","example":"2018-08-07 13:16:15","type":"string"},"ris_status":{"$ref":"#/components/schemas/TestResult","description":"The status of a reverse-image-search test on this Truepic.","example":"P"},"sdk_platform":{"description":"The platform on which this Truepic was captured","enum":["ios","Android"],"example":"Android","type":"string"},"sdk_version":{"description":"The version of the SDK on which this Truepic was captured.","example":"2.0.6","type":"string"},"shas256_hash":{"description":"The sha 256 hash of the Truepic signature","example":"900edbargawerfgaeawdefq34fawedfgadfghadfghaerghae5rtb2","type":"string"},"square_image":{"description":"A URL to a thumbnail of the image.","example":"https://d3tbfdtihunht2.cloudfront.net/qfzkoxugjn_s.mp4?...","type":"string"},"state":{"description":"The state where the photo/video was taken, based on GPS coordinates.","example":"CA","type":"string"},"status_overridden":true,"ts":{"description":"The timestamp of the capture of the Truepic","example":"2018-08-07 13:16:15","type":"string"},"type":{"description":"The type of capture","enum":["image","video"],"example":"image","type":"string"},"tz":{"description":"The timezone where the Truepic was taken","example":"America/Phoenix","type":"string"},"updated_at":{"description":"The date/time the resource was last updated","example":"2020-05-01T21:44:40.000Z","format":"date-time","type":"string"},"username":{"description":"The username of the capturer of the Truepic","example":"Apple","type":"string"},"verification_code":{"description":"The unique alphanumeric identifier of the photo/video.","type":"string"},"web_image":{"description":"A URL to a web-optimized version of the image.","example":"https://d3tbfdtihunht2.cloudfront.net/qfzkoxugjn_w.jpg?...","type":"string"}},"required":["ai_analysis_status","archived","blockchain_status","capture_integrity_status","container_id","content_analysis_status","created_at","datetime_status","device_fingerprint_id","device_id","device_integrity_status","device_time","distance_from_organization_address","distance_from_organization_address_exceeds_threshold","geolocation_status","id","inspection_id","is_deleted","is_rooted","lat","lens_transfer_done","lng","local_ts","object_detection_status","pending_upload","pop_status","ris_status","status_overridden","ts","tz","updated_at","username","verification_code"],"type":"object"},"InspectionType":{"additionalProperties":false,"description":"The core resource representing an inspection request","properties":{"created_at":{"description":"The date/time the resource was created","example":"2020-05-01T21:44:40.000Z","format":"date-time","type":"string"},"created_by_member_user_id":{"description":"the id of the user who created this inspection type. References `users.id`","example":2343,"type":"number"},"custom_fields":{"description":"An array of custom fields that are used by this inspection type","items":{"$ref":"#/components/schemas/CustomField"},"type":"array"},"id":{"description":"The id of the inspection type","example":1843,"type":"number"},"inspection_alert_config_id":{"description":"The id of the inspection alert configuration that is used by this inspection type. References `inspection_alert_configs.id`","example":539,"type":"number"},"inspection_ready_criteria_text":{"description":"Optional inspection-ready criteria text for this inspection type.","example":"Capture the VIN plate clearly and include a full odometer photo.","type":"string","nullable":true},"is_address_required":{"description":"Controls whether an address is required for the inspection or not","example":1000,"type":"boolean"},"is_deleted":true,"is_list_locked":{"description":"When true, the list associated with this inspection type cannot be changed","example":false,"type":"boolean"},"language":{"$ref":"#/components/schemas/LocalizationLanguages","description":"The IETF language tag for the intended language of the inspection. Non-customizable text in emails will use the language specified here."},"list_id":{"description":"The id of the list that is used by this inspection type. References `lists.id`","example":3345,"type":"number"},"max_distance_from_address_threshold":{"description":"the maximum distance away from the configured inspection address that an inspection can be completed in meters.","example":1000,"type":"number"},"message_template_set_id":{"description":"The id of the message template set that is used by this inspection type. References `message_template_sets.id`","example":539,"type":"number"},"modified_by_member_user_id":{"description":"the id of the user who last modified this inspection type. References `users.id`","example":2343,"type":"number"},"name":{"description":"The name of the inspection type","example":"My Type","type":"string"},"organization_id":{"description":"the id of the organization that this inspection type belongs to. References `organizations.id`.","example":14,"type":"number"},"outcome_set_id":{"description":"The id of the outcome set that is used by this inspection type. References `outcome_sets.id`","example":539,"type":"number"},"team_id":{"deprecated":true,"description":"the id of the team that this inspection type belongs to. References `teams.id`. Note that this is no longer used, and inspection types can now be associated with multiple teams","example":124,"type":"number"},"updated_at":{"description":"The date/time the resource was last updated","example":"2020-05-01T21:44:40.000Z","format":"date-time","type":"string"},"use_single_name_field":{"description":"When true, there is only one name for the user to fill out rather than a separate first name and last name field","example":true,"type":"boolean"}},"required":["created_at","custom_fields","id","is_address_required","is_deleted","is_list_locked","language","message_template_set_id","name","organization_id","team_id","updated_at","use_single_name_field"],"type":"object"},"InspectionTypeData":{"additionalProperties":false,"properties":{"created_at":{"description":"The date/time the resource was created","example":"2020-05-01T21:44:40.000Z","format":"date-time","type":"string"},"created_by_member_user_id":{"description":"the id of the user who created this inspection type. References `users.id`","example":2343,"type":"number"},"custom_fields":{"description":"An array of custom fields that are used by this inspection type","items":{"$ref":"#/components/schemas/CustomField"},"type":"array"},"id":{"description":"The id of the inspection type","example":1843,"type":"number"},"inspection_alert_config_id":{"description":"The id of the inspection alert configuration that is used by this inspection type. References `inspection_alert_configs.id`","example":539,"type":"number"},"inspection_ready_criteria_text":{"description":"Optional inspection-ready criteria text for this inspection type.","example":"Capture the VIN plate clearly and include a full odometer photo.","type":"string","nullable":true},"is_address_required":{"description":"Controls whether an address is required for the inspection or not","example":1000,"type":"boolean"},"is_list_locked":{"description":"When true, the list associated with this inspection type cannot be changed","example":false,"type":"boolean"},"language":{"$ref":"#/components/schemas/LocalizationLanguages","description":"The IETF language tag for the intended language of the inspection. Non-customizable text in emails will use the language specified here."},"list_id":{"description":"The id of the list that is used by this inspection type. References `lists.id`","example":3345,"type":"number"},"max_distance_from_address_threshold":{"description":"the maximum distance away from the configured inspection address that an inspection can be completed in meters.","example":1000,"type":"number"},"message_template_set_id":{"description":"The id of the message template set that is used by this inspection type. References `message_template_sets.id`","example":539,"type":"number"},"modified_by_member_user_id":{"description":"the id of the user who last modified this inspection type. References `users.id`","example":2343,"type":"number"},"name":{"description":"The name of the inspection type","example":"My Type","type":"string"},"outcome_set_id":{"description":"The id of the outcome set that is used by this inspection type. References `outcome_sets.id`","example":539,"type":"number"},"updated_at":{"description":"The date/time the resource was last updated","example":"2020-05-01T21:44:40.000Z","format":"date-time","type":"string"},"use_single_name_field":{"description":"When true, there is only one name for the user to fill out rather than a separate first name and last name field","example":true,"type":"boolean"}},"required":["id","name","is_list_locked","message_template_set_id","is_address_required","use_single_name_field","custom_fields","language","created_at","updated_at"],"type":"object"},"LandingPageContentSerialized":{"additionalProperties":false,"properties":{"assets":{"additionalProperties":{"type":"string"},"type":"object"},"color_primary":{"description":"The primary hex color code used for branding in the app.","example":"#0F7EC1","type":"string"},"page_body":{"description":"The body of the landing page.","example":"Fill out the form below to get started...","type":"string"},"page_title":{"description":"The title of the landing page.","example":"Start your application today!","type":"string"},"website_form":{"additionalProperties":false,"properties":{"token":{"description":"The unique token used by the website form to authenticate with the API.","example":"-SQuSE62r4ISFCE4EOOTtu3yx1SW8i6PE7VMZwvVZ8TNyliC","type":"string"}},"required":["token"],"type":"object"}},"required":["assets","page_body","page_title","website_form"],"type":"object"},"LandingPageSerialized":{"additionalProperties":false,"properties":{"created_at":{"description":"The date/time the resource was created","example":"2020-05-01T21:44:40.000Z","format":"date-time","type":"string"},"id":{"description":"The ID of the landing page.","example":123,"type":"number"},"inspection_type_ids":{"description":"The IDs of the inspection types that can be created from the landing page.","example":[123,456],"items":{"type":"number"},"type":"array"},"name":{"description":"The name of the landing page.","example":"Landing Page","type":"string"},"page_body":{"description":"The body of the landing page.","example":"Fill out the form below to get started...","type":"string"},"page_title":{"description":"The title of the landing page.","example":"Start your application today!","type":"string"},"slug":{"description":"The slug of the landing page that's used as the URL path. Must be unique for the organization.","example":"landing-page","type":"string"},"team_id":{"description":"The ID of the team that the landing page belongs to.","example":789,"type":"number"},"updated_at":{"description":"The date/time the resource was last updated","example":"2020-05-01T21:44:40.000Z","format":"date-time","type":"string"},"url":{"description":"The public URL of the landing page.","example":"https://organization-slug.truepic.io/landing-page-slug","type":"string"}},"required":["created_at","id","name","page_body","page_title","slug","team_id","updated_at"],"type":"object"},"LensActivityLocationData":{"additionalProperties":false,"description":"The location where a recorded activity took place","properties":{"accuracy":{"description":"The accuracy of GPS reading in meters.","example":10,"type":"number"},"altitude":{"description":"The altitude of the GPS reading in meters.","example":132.6,"type":"number","nullable":true},"city":{"description":"The city component of the address.","example":"Dover","type":"string"},"country":{"description":"The ISO 3166-1 two-letter country code component of the address.","example":"US","type":"string"},"formatted_address":{"description":"The full address formatted appropriately for the locale.","example":"206 Pebble Valley Drive, Dover, DE 19904","type":"string"},"latitude":{"description":"The GPS latitude in decimal degrees.","example":35.2726478,"type":"number"},"longitude":{"description":"The GPS longitude in decimal degrees.","example":89.2764478,"type":"number"},"postal_code":{"description":"The postal code component of the address.","example":"19904","type":"string"},"source":{"anyOf":[{"$ref":"#/components/schemas/LocationSource"},{"nullable":true}],"description":"The source of the location data.","example":"system"},"spoofed_reason":{"anyOf":[{"$ref":"#/components/schemas/LocationSpoofReason"},{"nullable":true}],"description":"The reason if spoofing was detected.","example":"accuracy_high"},"state":{"description":"The state component of the address.","example":"DE","type":"string"},"street":{"description":"The street component of the address.","example":"206 Pebble Valley Drive","type":"string"},"timestamp":{"description":"The date/time of the GPS reading. ISO 8601 format.","example":"2020-05-01T21:44:40.000Z","format":"date-time","type":"string"}},"required":["latitude","longitude","accuracy","altitude","street","city","state","postal_code","country","formatted_address","timestamp"],"type":"object"},"List":{"additionalProperties":false,"description":"A list of photos/videos and questions to prompt the customer for during an inspection.","properties":{"created_at":{"description":"The date/time the resource was created","example":"2020-05-01T21:44:40.000Z","format":"date-time","type":"string"},"created_by_member_user_id":{"description":"The id of the user that created this list","example":609,"type":"number"},"groups":{"$ref":"#/components/schemas/ListItemGroups","description":"The groups of items in the list","example":{"grp1":{"name":"Group 2"}}},"id":{"description":"The id of the resource.","example":1843,"type":"number"},"inspection_id":{"description":"The id of the inspection that this list belongs to","example":6342,"type":"number"},"is_deleted":true,"name":{"description":"The auto-generated name of the list.","example":"List for Inspection 3527","type":"string"},"organization_id":{"description":"The id of the organization that this list belongs to","example":52,"type":"number"},"team_id":{"description":"The id of the team that this list belongs to","example":66,"type":"number"},"type":{"$ref":"#/components/schemas/ListType","description":"The type of the list. Must be `EVENT_TEMPLATE`, `EVENT_INSTANCE`, `SURVEY_TEMPLATE`, or `SURVEY_INSTANCE`","example":"EVENT_TEMPLATE"},"updated_at":{"description":"The date/time the resource was last updated","example":"2020-05-01T21:44:40.000Z","format":"date-time","type":"string"}},"required":["created_at","id","is_deleted","name","organization_id","type","updated_at"],"type":"object"},"ListItem":{"additionalProperties":false,"description":"A photo/video or question to prompt the customer for during an inspection.","properties":{"accept_existing_images":{"description":"Whether or not to accept existing images for this list item.","example":false,"type":"boolean"},"ai_analysis_set_id":{"description":"The id of the AI Analysis Set used for Vision AI Analysis. References `ai_analysis_sets.id`","example":3,"type":"number","nullable":true},"capture_max":{"description":"Limit the number of images taken for this list item. Must be positive number","example":11,"type":"number"},"condition_id":{"description":"A unique identifier used to create conditional list items in conjunction with the `conditions` field on another list item. It's best to generate a unique value for this field.","maxLength":255,"type":"string"},"conditions":{"description":"An array mapping answers to conditions. Use this field in conjunction with the `condition_id` on another list item (the \"parent\" item) to make this item (the \"child\" item) only appear when a specific answer is given on the parent item. Up to 5 layers of nested conditional items can be created.","items":{"additionalProperties":false,"properties":{"id":{"description":"The condition_id of the \"parent\" list item that this list item is triggered by.","type":"string"},"question":{"additionalProperties":false,"properties":{"answer":{"description":"The answer that triggers the associated condition","type":"string"}},"required":["answer"],"type":"object"}},"required":["id","question"],"type":"object"},"type":"array"},"content_analysis":{"$ref":"#/components/schemas/ContentAnalysisDetails","description":"Indicates that the contents of the photo should be analyzed to determine if it contains the correct information."},"created_at":{"description":"The date/time the resource was created","example":"2020-05-01T21:44:40.000Z","format":"date-time","type":"string"},"created_by_member_user_id":{"description":"The id of the member that created this list item.","example":634,"type":"number"},"custom_data":{"additionalProperties":{},"description":"Any additional data that should be stored with the list item.","example":{"key":"value"},"maxLength":1000,"type":"object"},"example_photo":{"description":"The url location of the example photo for the list item. Note: you cannot have both an example photo and an example video.","type":"string"},"example_photo_square":{"description":"The url location of the square example photo (thumbnail) for the list item.","type":"string"},"example_video":{"description":"The url location of the example video for the list item. This must be a valid YouTube or Vimeo URL embedding URL. Note: you cannot have both an example video and an example photo.","type":"string"},"expected_required":{"description":"Indicates whether or not an `expected` criteria needs to be entered at the time the inspection is sent.","example":true,"type":"boolean"},"group_id":{"description":"The id of the group that this list item is associated with.","example":1256,"type":"string"},"id":{"description":"The id of the resource.","example":1843,"type":"number"},"incomplete_at":{"description":"The timestamp when the list item was marked as incomplete.","type":"string"},"is_deleted":true,"is_required":true,"list_id":{"description":"The id of the list that is item is associated with.","example":1256,"type":"number"},"name":{"description":"A description of the requested photo or video when `type` is `IMAGE`, `PHOTO`, or `VIDEO`. A question for the customer to answer when `type` is `QUESTION`. The customer will see this value in the Vision app during the inspection.","example":"Front of car","maxLength":1500,"type":"string"},"object_detection":{"$ref":"#/components/schemas/ObjectDetectionConfig","description":"An object containing information about the expected items in a Truepic."},"order":{"description":"The numerical order of the list item within the list. Starts at `1`.","example":1,"type":"number"},"type":{"$ref":"#/components/schemas/ListItemType","description":"The type of the list item."},"updated_at":{"description":"The date/time the resource was last updated","example":"2020-05-01T21:44:40.000Z","format":"date-time","type":"string"}},"required":["created_at","created_by_member_user_id","id","is_deleted","is_required","list_id","name","type","updated_at"],"type":"object"},"ListItemDateQuestion":{"additionalProperties":false,"description":"Date question","properties":{"answer":{"description":"The user's date answer as a string, or null if unanswered","type":"string","nullable":true},"created_at":{"description":"The date/time the resource was created","example":"2020-05-01T21:44:40.000Z","format":"date-time","type":"string"},"id":{"description":"The id of the resource.","example":1843,"type":"number"},"list_item_id":{"description":"The id of the list item this question is for","example":643,"type":"number"},"options":{"additionalProperties":false,"description":"No options for date questions","properties":{"max":{"description":"The latest date that can be selected, in ISO 8601 format","type":"string"},"min":{"description":"The earliest date that can be selected, in ISO 8601 format","type":"string"}},"type":"object"},"type":{"description":"The type of question this list item is. Must be `MULTIPLE_CHOICE`, `TEXT`, or `DATE`.","type":"string"},"updated_at":{"description":"The date/time the resource was last updated","example":"2020-05-01T21:44:40.000Z","format":"date-time","type":"string"}},"required":["created_at","id","list_item_id","type","updated_at"],"type":"object"},"ListItemGroups":{"additionalProperties":{"additionalProperties":false,"properties":{"name":{"type":"string"}},"required":["name"],"type":"object"},"type":"object"},"ListItemMultipleChoiceQuestion":{"additionalProperties":false,"description":"Multiple choice question","properties":{"answer":{"anyOf":[{"nullable":true},{"items":{"additionalProperties":false,"properties":{"custom":{"description":"The user's custom text answer. Used for answer options where `allow_custom` is `true`","type":"string"},"name":{"description":"A selected answer to the question.","example":"Excellent","type":"string"}},"required":["name"],"type":"object"},"type":"array"}],"description":"The answer(s) selected by the user, or null if unanswered"},"created_at":{"description":"The date/time the resource was created","example":"2020-05-01T21:44:40.000Z","format":"date-time","type":"string"},"id":{"description":"The id of the resource.","example":1843,"type":"number"},"list_item_id":{"description":"The id of the list item this question is for","example":643,"type":"number"},"options":{"additionalProperties":false,"description":"The possible choices for this question","properties":{"allow_multiple":{"type":"boolean"},"choices":{"items":{"$ref":"#/components/schemas/ListItemQuestionChoice"},"type":"array"}},"required":["choices","allow_multiple"],"type":"object"},"type":{"description":"The type of question this list item is. Must be `MULTIPLE_CHOICE`, `TEXT`, or `DATE`.","type":"string"},"updated_at":{"description":"The date/time the resource was last updated","example":"2020-05-01T21:44:40.000Z","format":"date-time","type":"string"}},"required":["created_at","id","list_item_id","options","type","updated_at"],"type":"object"},"ListItemPayload":{"additionalProperties":false,"properties":{"accept_existing_images":{"description":"Whether or not to accept existing images for this list item.","example":false,"type":"boolean"},"ai_analysis_set_id":{"description":"The id of the AI Analysis Set used for Vision AI Analysis. References `ai_analysis_sets.id`","example":3,"type":"number","nullable":true},"capture_max":{"description":"Limit the number of images taken for this list item. Must be positive number","example":11,"type":"number"},"condition_id":{"description":"A unique identifier used to create conditional list items in conjunction with the `conditions` field on another list item. It's best to generate a unique value for this field.","maxLength":255,"type":"string"},"conditions":{"description":"An array mapping answers to conditions. Use this field in conjunction with the `condition_id` on another list item (the \"parent\" item) to make this item (the \"child\" item) only appear when a specific answer is given on the parent item. Up to 5 layers of nested conditional items can be created.","items":{"additionalProperties":false,"properties":{"id":{"description":"The condition_id of the \"parent\" list item that this list item is triggered by.","type":"string"},"question":{"additionalProperties":false,"properties":{"answer":{"description":"The answer that triggers the associated condition","type":"string"}},"required":["answer"],"type":"object"}},"required":["id","question"],"type":"object"},"type":"array"},"content_analysis":{"$ref":"#/components/schemas/ContentAnalysisDetails","description":"Indicates that the contents of the photo should be analyzed to determine if it contains the correct information."},"custom_data":{"additionalProperties":{},"description":"Any additional data that should be stored with the list item.","example":{"key":"value"},"maxLength":1000,"type":"object"},"example_photo":{"description":"The url location of the example photo for the list item. Note: you cannot have both an example photo and an example video.","type":"string"},"example_photo_square":{"description":"The url location of the square example photo (thumbnail) for the list item.","type":"string"},"example_video":{"description":"The url location of the example video for the list item. This must be a valid YouTube or Vimeo URL embedding URL. Note: you cannot have both an example video and an example photo.","type":"string"},"expected_required":{"description":"Indicates whether or not an `expected` criteria needs to be entered at the time the inspection is sent.","example":true,"type":"boolean"},"group_id":{"description":"The id of the group that this list item is associated with.","example":1256,"type":"string"},"id":{"description":"The id of the resource.","type":"number"},"incomplete":{"description":"Set to true to mark this list item as \"incomplete\" when sending a request for more photos/videos.","example":true,"type":"boolean"},"is_required":true,"name":{"description":"A description of the requested photo or video when `type` is `IMAGE`, `PHOTO`, or `VIDEO`. A question for the customer to answer when `type` is `QUESTION`. The customer will see this value in the Vision app during the inspection.","example":"Front of car","maxLength":1500,"type":"string"},"object_detection":{"$ref":"#/components/schemas/ObjectDetectionConfig","description":"An object containing information about the expected items in a Truepic."},"order":{"description":"The numerical order of the list item within the list. Starts at `1`.","example":1,"type":"number"},"question":{"$ref":"#/components/schemas/ListItemQuestion"},"type":{"$ref":"#/components/schemas/ListItemType","description":"The type of the list item."}},"required":["id","is_required","name","type"],"type":"object"},"ListItemQuestion":{"anyOf":[{"$ref":"#/components/schemas/ListItemMultipleChoiceQuestion"},{"$ref":"#/components/schemas/ListItemTextQuestion"},{"$ref":"#/components/schemas/ListItemDateQuestion"}],"description":"Union type for all question types"},"ListItemQuestionBase":{"additionalProperties":false,"description":"Base interface for a question on a list item","properties":{"created_at":{"description":"The date/time the resource was created","example":"2020-05-01T21:44:40.000Z","format":"date-time","type":"string"},"id":{"description":"The id of the resource.","example":1843,"type":"number"},"list_item_id":{"description":"The id of the list item this question is for","example":643,"type":"number"},"type":{"$ref":"#/components/schemas/ListItemQuestionType","description":"The type of question this list item is. Must be `MULTIPLE_CHOICE`, `TEXT`, or `DATE`.","example":"TEXT"},"updated_at":{"description":"The date/time the resource was last updated","example":"2020-05-01T21:44:40.000Z","format":"date-time","type":"string"}},"required":["created_at","id","list_item_id","type","updated_at"],"type":"object"},"ListItemQuestionChoice":{"additionalProperties":false,"properties":{"allow_custom":{"description":"Whether to allow custom text input for this possible answer option.","example":true,"type":"boolean"},"name":{"description":"A possible answer to the question.","example":"Excellent","type":"string"}},"required":["name","allow_custom"],"type":"object"},"ListItemQuestionType":{"enum":["TEXT","MULTIPLE_CHOICE","DATE"],"type":"string"},"ListItemTextQuestion":{"additionalProperties":false,"description":"Text question","properties":{"answer":{"description":"The user's text answer, or null if unanswered","type":"string","nullable":true},"created_at":{"description":"The date/time the resource was created","example":"2020-05-01T21:44:40.000Z","format":"date-time","type":"string"},"id":{"description":"The id of the resource.","example":1843,"type":"number"},"list_item_id":{"description":"The id of the list item this question is for","example":643,"type":"number"},"options":{"description":"No options for text questions","nullable":true},"type":{"description":"The type of question this list item is. Must be `MULTIPLE_CHOICE`, `TEXT`, or `DATE`.","type":"string"},"updated_at":{"description":"The date/time the resource was last updated","example":"2020-05-01T21:44:40.000Z","format":"date-time","type":"string"}},"required":["created_at","id","list_item_id","type","updated_at"],"type":"object"},"ListItemType":{"enum":["IMAGE","VIDEO","PHOTO","QUESTION"],"type":"string"},"ListType":{"enum":["EVENT_TEMPLATE","EVENT_INSTANCE","SURVEY_TEMPLATE","SURVEY_INSTANCE"],"type":"string"},"LocalizationLanguages":{"enum":["en","es","fr-ca"],"type":"string"},"Location":{"additionalProperties":false,"description":"A location record that contains information about the location of a device when an action was performed in an inspection.","properties":{"accuracy":{"description":"The accuracy of the GPS data.","example":5,"type":"number"},"altitude":{"description":"The altitude of this location.","example":30,"type":"number","nullable":true},"city":{"description":"The city of this location.","example":"San Francisco","type":"string"},"country":{"description":"The country code of this location.","example":"US","type":"string"},"created_at":{"description":"The date/time the resource was created","example":"2020-05-01T21:44:40.000Z","format":"date-time","type":"string"},"formatted_address":{"description":"The formatted address of this location.","example":"30 Main St, San Francisco, CA 94105","type":"string"},"id":{"description":"The id of the location record.","example":1843,"type":"number"},"latitude":{"description":"The latitude of this location.","example":37.7749,"type":"number"},"longitude":{"description":"The longitude of this location.","example":-122.4194,"type":"number"},"postal_code":{"description":"The postal code of this location.","example":"94105","type":"string"},"source":{"anyOf":[{"$ref":"#/components/schemas/LocationSource"},{"nullable":true}],"description":"The source of the location data.","example":"system"},"spoofed":{"$ref":"#/components/schemas/LocationSpoofReason","description":"Indicates if the GPS data is spoofed.","example":"not_spoofed"},"state":{"description":"The state of this location.","example":"CA","type":"string"},"street_address":{"description":"The street address of this location.","example":"30 Main St","type":"string"},"timestamp":{"description":"A timestamp from the GPS data.","example":"2023-10-01T12:00:00Z","type":"string"},"updated_at":{"description":"The date/time the resource was last updated","example":"2020-05-01T21:44:40.000Z","format":"date-time","type":"string"}},"required":["accuracy","altitude","created_at","id","latitude","longitude","spoofed","timestamp","updated_at"],"type":"object"},"LocationSource":{"description":"The source of the location data.","enum":["accessory","software","system"],"type":"string"},"LocationSpoofReason":{"enum":["not_spoofed","spoof_reason_not_specified","mock_simulated","accuracy_high","timestamp_old","accuracy_chrome_devtools","altitude_missing","teleported","speed_vertical_accuracy_missing","accessory","bad_spoof_reason"],"type":"string"},"MessageTemplateSet":{"additionalProperties":false,"description":"A set of templates used for messages sent via email or text to an app user","properties":{"auto_reply":{"description":"The message template for messages sent as automated replies when an app user sends a message to a member/dashboard-user.","type":"string"},"created_at":{"description":"The date/time the resource was created","example":"2020-05-01T21:44:40.000Z","format":"date-time","type":"string"},"finish_reminder":{"description":"The message template for messages sent as reminders for started, but unfinished inspection requests.","example":"Hi {{OrganizationFirstName}}, this is {{MemberName}} from {{CompanyName}} reminding you that you have until {{ExpirationDueDateTime}} to finish your inspection. Please tap the following link to open the Truepic Vision app and return to your inspection: {{SmartLink}} {{CustomNote}} Thank you, and please call us at {{ClientSupportNumber}} with any questions.","type":"string"},"finish_reminder_subject":{"description":"The message template for messages sent as reminders to finish inspections.","example":"Reminder to finish inspection for {{OrganizationFirstName}}","type":"string"},"id":{"description":"The id of the resource.","example":1843,"type":"number"},"inspection_finished":{"description":"The message template for messages sent for finished inspection requests.","example":"Hi {{OrganizationFirstName}}. Your inspection has been completed and we will reach out with a result shortly. Thank you, and please call us at {{ClientSupportNumber}} with any questions.","type":"string"},"inspection_finished_enabled":{"default":false,"description":"Whether or not the \"inspection finished\" message is enabled and will be sent.","example":false,"type":"boolean"},"inspection_finished_subject":{"description":"The email subject for messages sent for finished inspection requests.","example":"Inspection Finished for {{OrganizationFirstName}}","type":"string"},"is_deleted":true,"name":{"description":"The name of the message template set","example":"Default Set","maxLength":255,"type":"string"},"new_request":{"description":"The message template for messages sent for new inspection requests.","example":"Hi {{OrganizationFirstName}}, this is {{MemberName}} reaching out to request photos. To begin, click on the following link to download the Truepic Vision app: {{SmartLink}} Follow the onscreen instructions to capture photos. Please note, this request will expire on {{ExpirationDueDateTime}}. {{CustomNote}} Thank you, and please contact us with any questions.","type":"string"},"new_request_subject":{"description":"The email subject for messages sent for new inspection requests.","example":"New Inspection for {{OrganizationFirstName}}","type":"string"},"organization_id":{"description":"The id of the organization that this message template set belongs to","example":521,"type":"number"},"request_more":{"description":"The message template for messages sent to request additional items on an inspection request.","example":"Hi {{OrganizationFirstName}}, this is {{MemberName}} requesting that you upload additional photos. To begin, click on the following link to download the Truepic Vision app: {{SmartLink}} Follow the onscreen instructions to capture photos. Please note, this request will expire on {{ExpirationDueDateTime}}. {{CustomNote}} Thank you, and please contact us with any questions.","type":"string"},"request_more_subject":{"description":"The message template for messages sent as requests for more photos on inspections.","example":"More Photos Requested for {{OrganizationFirstName}}","type":"string"},"request_reminder":{"description":"The message template for messages sent as reminders for pending inspection requests.","example":"Hi {{OrganizationFirstName}}, this is {{MemberName}} sending a reminder that you have not yet submitted the requested photos. To begin, click on the following link to download the Truepic Vision app: {{SmartLink}} Follow the onscreen instructions to capture photos. Please note, this request will expire on {{ExpirationDueDateTime}}. {{CustomNote}} Thank you, and please contact us with any questions.","type":"string"},"request_reminder_subject":{"description":"The email subject for messages sent as reminders for non-started inspections.","example":"Inspection Reminder for {{OrganizationFirstName}}","type":"string"},"team_id":{"description":"The id of the team that this message template set belongs to","example":521,"type":"number"},"updated_at":{"description":"The date/time the resource was last updated","example":"2020-05-01T21:44:40.000Z","format":"date-time","type":"string"}},"required":["auto_reply","created_at","finish_reminder_subject","id","inspection_finished","inspection_finished_enabled","inspection_finished_subject","is_deleted","name","new_request","new_request_subject","request_more","request_more_subject","request_reminder","request_reminder_subject","updated_at"],"type":"object"},"MessageTemplateSetData":{"additionalProperties":false,"properties":{"auto_reply":{"description":"The message template for messages sent as automated replies when an app user sends a message to a member/dashboard-user.","type":"string"},"created_at":{"description":"The date/time the resource was created","example":"2020-05-01T21:44:40.000Z","format":"date-time","type":"string"},"finish_reminder":{"description":"The message template for messages sent as reminders for started, but unfinished inspection requests.","example":"Hi {{OrganizationFirstName}}, this is {{MemberName}} from {{CompanyName}} reminding you that you have until {{ExpirationDueDateTime}} to finish your inspection. Please tap the following link to open the Truepic Vision app and return to your inspection: {{SmartLink}} {{CustomNote}} Thank you, and please call us at {{ClientSupportNumber}} with any questions.","type":"string"},"finish_reminder_subject":{"description":"The message template for messages sent as reminders to finish inspections.","example":"Reminder to finish inspection for {{OrganizationFirstName}}","type":"string"},"id":{"description":"The id of the resource.","example":1843,"type":"number"},"inspection_finished":{"description":"The message template for messages sent for finished inspection requests.","example":"Hi {{OrganizationFirstName}}. Your inspection has been completed and we will reach out with a result shortly. Thank you, and please call us at {{ClientSupportNumber}} with any questions.","type":"string"},"inspection_finished_enabled":{"default":false,"description":"Whether or not the \"inspection finished\" message is enabled and will be sent.","example":false,"type":"boolean"},"inspection_finished_subject":{"description":"The email subject for messages sent for finished inspection requests.","example":"Inspection Finished for {{OrganizationFirstName}}","type":"string"},"name":{"description":"The name of the message template set","example":"Default Set","maxLength":255,"type":"string"},"new_request":{"description":"The message template for messages sent for new inspection requests.","example":"Hi {{OrganizationFirstName}}, this is {{MemberName}} reaching out to request photos. To begin, click on the following link to download the Truepic Vision app: {{SmartLink}} Follow the onscreen instructions to capture photos. Please note, this request will expire on {{ExpirationDueDateTime}}. {{CustomNote}} Thank you, and please contact us with any questions.","type":"string"},"new_request_subject":{"description":"The email subject for messages sent for new inspection requests.","example":"New Inspection for {{OrganizationFirstName}}","type":"string"},"request_more":{"description":"The message template for messages sent to request additional items on an inspection request.","example":"Hi {{OrganizationFirstName}}, this is {{MemberName}} requesting that you upload additional photos. To begin, click on the following link to download the Truepic Vision app: {{SmartLink}} Follow the onscreen instructions to capture photos. Please note, this request will expire on {{ExpirationDueDateTime}}. {{CustomNote}} Thank you, and please contact us with any questions.","type":"string"},"request_more_subject":{"description":"The message template for messages sent as requests for more photos on inspections.","example":"More Photos Requested for {{OrganizationFirstName}}","type":"string"},"request_reminder":{"description":"The message template for messages sent as reminders for pending inspection requests.","example":"Hi {{OrganizationFirstName}}, this is {{MemberName}} sending a reminder that you have not yet submitted the requested photos. To begin, click on the following link to download the Truepic Vision app: {{SmartLink}} Follow the onscreen instructions to capture photos. Please note, this request will expire on {{ExpirationDueDateTime}}. {{CustomNote}} Thank you, and please contact us with any questions.","type":"string"},"request_reminder_subject":{"description":"The email subject for messages sent as reminders for non-started inspections.","example":"Inspection Reminder for {{OrganizationFirstName}}","type":"string"},"updated_at":{"description":"The date/time the resource was last updated","example":"2020-05-01T21:44:40.000Z","format":"date-time","type":"string"}},"required":["id","name","new_request","request_reminder","request_more","auto_reply","inspection_finished","inspection_finished_enabled","inspection_finished_subject","new_request_subject","request_reminder_subject","request_more_subject","finish_reminder_subject","created_at","updated_at"],"type":"object"},"ObjectDetectionAutomotiveObject":{"enum":["tire","vin_plate","dashboard","license_plate","odometer","document"],"type":"string"},"ObjectDetectionCategory":{"description":"The possible statuses for an inspection.","enum":["jewelry","auto","real_estate"],"type":"string"},"ObjectDetectionConfig":{"additionalProperties":false,"properties":{"category":{"$ref":"#/components/schemas/ObjectDetectionCategory","description":"The category of item expected in this list item","example":"jewelry"},"objects":{"description":"An array of objects (physical items) expected in this Truepic","example":["bracelet","watch"],"items":{"$ref":"#/components/schemas/ObjectDetectionObject"},"type":"array"},"warn_if":{"$ref":"#/components/schemas/ObjectDetectionWarningMethodology","description":"How the object detection result will be calculated, defaults to 'NONE' meaning the user will not be warned if none of the objects are detected."}},"required":["category"],"type":"object"},"ObjectDetectionJewelryObject":{"enum":["necklace","ring","watch","earrings","bracelet"],"type":"string"},"ObjectDetectionObject":{"anyOf":[{"$ref":"#/components/schemas/ObjectDetectionAutomotiveObject"},{"$ref":"#/components/schemas/ObjectDetectionJewelryObject"},{"$ref":"#/components/schemas/ObjectDetectionRealEstateObject"}]},"ObjectDetectionRealEstateObject":{"enum":["risks","pool","pool_cage","swing_set","trampoline","fence","dog","fireplace","wood_stove","bbq"],"type":"string"},"ObjectDetectionWarningMethodology":{"description":"The possible statuses for an inspection.","enum":["NONE","ANY"],"type":"string"},"OdometerExpectedValue":{"additionalProperties":false,"properties":{"max":{"description":"The maximum number expected on the odometer reading.","example":35000,"type":"number","nullable":true},"min":{"description":"The minimum number expected on the odometer reading.","example":30000,"type":"number","nullable":true}},"required":["min","max"],"type":"object"},"Operation":{"additionalProperties":false,"description":"A long-running background job that can be tracked to monitor its progress, such as a PDF export.","properties":{"completed_at":{"description":"The timestamp that the operation finished at.","example":"2023-05-25 19:32:02.95","format":"date-time","type":"string"},"created_at":{"description":"The date/time the resource was created","example":"2020-05-01T21:44:40.000Z","format":"date-time","type":"string"},"id":{"description":"The id of the resource.","example":1843,"type":"number"},"resource_id":{"description":"The ID of the resource the operation is primarily working on.","example":123,"type":"number"},"resource_type":{"description":"The type of resource the operation is primarily working on.","example":"Inspection","type":"string"},"result":{"anyOf":[{"additionalProperties":false,"properties":{"size":{"description":"The file size, in bytes, of an exported PDF","example":2399092,"type":"number"},"url":{"description":"The URL of a PDF export","format":"url","type":"string"}},"type":"object"},{"additionalProperties":false,"properties":{"error":{"description":"The returned error if a PDF export failed","example":"Error: Failed to launch the browser process","type":"string"}},"type":"object"}],"description":"An object containing the result of the operation"},"status":{"description":"The current state of the operation","enum":["WAITING","SUCCESS","ERROR"],"example":"WAITING","type":"string"},"team_id":{"description":"The id of the team that this operation is for","example":551,"type":"number"},"type":{"description":"The type of the operation","example":"inspections.export_pdf","type":"string"},"updated_at":{"description":"The date/time the resource was last updated","example":"2020-05-01T21:44:40.000Z","format":"date-time","type":"string"}},"required":["created_at","id","resource_id","resource_type","status","team_id","type","updated_at"],"type":"object"},"Organization":{"additionalProperties":false,"description":"An organization that uses Truepic to create inspections.","properties":{"auto_delete_customer_data_after_days":{"default":null,"description":"The number of days after which customer data (inspections, truepics, etc.) will be automatically deleted. A null value disables automatic deletion.","example":365,"type":"number","nullable":true},"created_at":{"description":"The date/time the resource was created","example":"2020-05-01T21:44:40.000Z","format":"date-time","type":"string"},"created_by_user_id":{"description":"The id of the user that created this organization.","example":1413,"type":"number"},"id":{"description":"The id of the resource.","example":1843,"type":"number"},"is_deleted":true,"is_mfa_required":true,"name":{"description":"The name of the organization.","example":"Quality Capital","type":"string"},"organization_slug":{"description":"The organization_slug of the organization used to access Vision.","example":"vision-test","type":"string"},"updated_at":{"description":"The date/time the resource was last updated","example":"2020-05-01T21:44:40.000Z","format":"date-time","type":"string"}},"required":["created_at","created_by_user_id","id","is_deleted","is_mfa_required","updated_at"],"type":"object"},"OrganizationEnabledFeature":{"additionalProperties":false,"description":"A feature that an organization may have enabled.","properties":{"created_at":{"description":"The date/time the resource was created","example":"2020-05-01T21:44:40.000Z","format":"date-time","type":"string"},"enabled":{"description":"Whether the feature is enabled for the organization","example":true,"type":"boolean"},"id":{"description":"The id of the resource","example":123,"type":"number"},"organization_id":{"description":"The id of the organization","example":1235,"type":"number"},"requested_access_at":{"description":"The date/time when the organization requested access to the feature if it couldn't be self-enabled","example":"2024-01-15T12:34:56.789Z","type":"string","nullable":true},"self_enabled":{"description":"Whether the feature has ever been self-enabled by the organization","example":true,"type":"boolean"},"type":{"$ref":"#/components/schemas/OrganizationEnabledFeatureType","description":"The type of feature the organization has enabled","example":"ask_for_app_review"},"updated_at":{"description":"The date/time the resource was last updated","example":"2020-05-01T21:44:40.000Z","format":"date-time","type":"string"},"updated_by_user_id":{"description":"The id of the user who last updated the feature","example":512,"type":"number","nullable":true}},"required":["created_at","enabled","id","organization_id","requested_access_at","self_enabled","type","updated_at","updated_by_user_id"],"type":"object"},"OrganizationEnabledFeatureType":{"enum":["ai_analysis","ask_for_app_review","inspection_device_insights","device_details","risk_network","external_risk_network","content_analysis_odometer","content_analysis_text_matching","content_analysis_vin","content_analysis_dot_tin","object_detection_auto","object_detection_jewelry","object_detection_real_estate","landing_pages","inspection_ai_criteria","dashboard_user_feedback_forms"],"type":"string"},"Outcome":{"additionalProperties":false,"description":"A possible outcome for an inspection","properties":{"created_at":{"description":"The date/time the resource was created","example":"2020-05-01T21:44:40.000Z","format":"date-time","type":"string"},"created_by_user_id":{"description":"The id of the user that created this outcome set.","example":894,"type":"number"},"id":{"description":"The id of the resource.","example":1843,"type":"number"},"is_deleted":true,"modified_by_user_id":{"description":"The id of the user that last edited this outcome set.","example":542,"type":"number"},"order":{"description":"The order that this outcome is listed in. Starts at 1","example":111,"type":"number"},"outcome_set_id":{"description":"The id of the outcome set that this outcome belongs to","example":111,"type":"number"},"updated_at":{"description":"The date/time the resource was last updated","example":"2020-05-01T21:44:40.000Z","format":"date-time","type":"string"}},"required":["created_at","created_by_user_id","id","is_deleted","order","outcome_set_id","updated_at"],"type":"object"},"OutcomeSet":{"additionalProperties":false,"description":"A set of outcomes possible when closing an inspection. Specific to each organization.","properties":{"created_at":{"description":"The date/time the resource was created","example":"2020-05-01T21:44:40.000Z","format":"date-time","type":"string"},"created_by_user_id":{"description":"The id of the user that created this outcome set.","example":894,"type":"number"},"id":{"description":"The id of the resource.","example":1843,"type":"number"},"is_deleted":true,"modified_by_user_id":{"description":"The id of the user that last edited this outcome set.","example":542,"type":"number"},"name":{"description":"The name of the outcome set","example":"Default","type":"string"},"organization_id":{"description":"The id of the organization that owns this outcome set.","example":532,"type":"number"},"updated_at":{"description":"The date/time the resource was last updated","example":"2020-05-01T21:44:40.000Z","format":"date-time","type":"string"}},"required":["created_at","created_by_user_id","id","is_deleted","name","organization_id","updated_at"],"type":"object"},"OverviewReadinessStatus":{"enum":["READY","NOT_READY"],"type":"string"},"PDFAttachmentSettings":{"additionalProperties":false,"properties":{"message_type":{"description":"The message type to attach the PDF to.","type":"string"},"timezone":{"description":"The timezone to use when generating the PDF file.","type":"string"}},"required":["message_type","timezone"],"type":"object"},"PaginationFiltering":{"additionalProperties":{"additionalProperties":false,"description":"The key is the property name to filter by.","properties":{"<":{"description":"Value must be less than this.","type":"string"},"<=":{"description":"Value must be less than or equal to this.","type":"string"},"=":{"description":"Value must equal this","type":"string"},">":{"description":"Value must be greater than this.","type":"string"},">=":{"description":"Value must be greater or equal to than this.","type":"string"},"in":{"description":"Value must be at least one of these","items":{"type":"string"},"type":"array"},"is":{"description":"Value must be this.","type":"string"},"is not":{"description":"Value must not be this.","type":"string"}},"type":"object"},"description":"General format for filtering results.","type":"object"},"PaginationQuery":{"additionalProperties":false,"description":"General format for paginated queries to limit the number of results returned.","properties":{"number":{"default":1,"description":"The page number to return.","example":1,"type":"number"},"size":{"default":20,"description":"The number of results to return per page.","example":25,"type":"number"}},"required":["number","size"],"type":"object"},"PaginationResult":{"additionalProperties":false,"description":"General format for paginated API results","properties":{"pageCount":{"description":"The total number of pages for the given query","example":12,"type":"number"},"result":{"description":"The items returned. Could be an array of any type, depending on the request.","items":{},"type":"array"},"total":{"description":"The total number of results for the given page","example":25,"type":"number"},"totalResults":{"description":"The total number of results for the given query","example":251,"type":"number"}},"required":["result","totalResults","total","pageCount"],"type":"object"},"PaginationSorting":{"additionalProperties":{"description":"The key is the property name to sort by. 'asc' to sort ascending. 'desc' to sort descending.","enum":["asc","desc"],"type":"string"},"description":"General format for sorting results. The order of properties given is important, as sorting is applied in the order specified.","type":"object"},"PopulatedCustomField":{"additionalProperties":false,"properties":{"custom_field_option_set_id":{"description":"The id of the custom field option set used by this custom field when the entry method is ENTRY_METHOD_SELECTABLE","type":"number"},"custom_field_options":{"description":"An array of custom field options used by this custom field when the entry method is ENTRY_METHOD_SELECTABLE","example":[{"label":"My Custom Field Option","value":"OPTION_VALUE"}],"items":{"$ref":"#/components/schemas/CustomFieldOption"},"type":"array"},"entry_method":{"$ref":"#/components/schemas/CustomFieldEntryMethods","description":"The entry method for the custom field"},"is_required":true,"label":{"description":"The label for the custom field","type":"string"}},"required":["entry_method","is_required"],"type":"object"},"PopulatedCustomFieldOptionSet":{"additionalProperties":false,"properties":{"created_at":{"description":"The date/time the resource was created","example":"2020-05-01T21:44:40.000Z","format":"date-time","type":"string"},"created_by_user_id":{"description":"The id of the user that created this option custom field option set.","example":894,"type":"number"},"id":{"description":"The id of the resource.","example":1843,"type":"number"},"inspection_types":{"items":{"additionalProperties":false,"properties":{"id":{"description":"The id of the inspection type","example":1843,"type":"number"},"name":{"description":"The name of the inspection type","example":"My Type","type":"string"}},"required":["id","name"],"type":"object"},"type":"array"},"is_deleted":true,"modified_by_user_id":{"description":"The id of the user that last edited this custom field option set.","example":542,"type":"number"},"name":{"description":"The name of the custom field option set","example":"Option Set Name","type":"string"},"options":{"description":"The available options in this option set","example":[{"name":"Option Label","value":"OPTION_ID"}],"items":{"additionalProperties":false,"properties":{"name":{"description":"The name of the option","type":"string"},"value":{"description":"The value of the option","example":"OPTION_ID","type":"string"}},"required":["value","name"],"type":"object"},"type":"array"},"organization_id":{"description":"The id of the organization that owns this custom field option set.","example":532,"type":"number"},"updated_at":{"description":"The date/time the resource was last updated","example":"2020-05-01T21:44:40.000Z","format":"date-time","type":"string"}},"required":["created_at","created_by_user_id","id","is_deleted","name","options","organization_id","updated_at"],"type":"object"},"PopulatedLocation":{"additionalProperties":false,"properties":{"accuracy":{"description":"The accuracy of the GPS data.","example":5,"type":"number"},"altitude":{"description":"The altitude of this location.","example":30,"type":"number","nullable":true},"city":{"description":"The city of this location.","example":"San Francisco","type":"string"},"country":{"description":"The country code of this location.","example":"US","type":"string"},"created_at":{"description":"The date/time the resource was created","example":"2020-05-01T21:44:40.000Z","format":"date-time","type":"string"},"distance_from_customer_address":{"description":"The distance (in meters) of this location from the customer address, if applicable.","example":50,"type":"number"},"formatted_address":{"description":"The formatted address of this location.","example":"30 Main St, San Francisco, CA 94105","type":"string"},"id":{"description":"The id of the location record.","example":1843,"type":"number"},"latitude":{"description":"The latitude of this location.","example":37.7749,"type":"number"},"longitude":{"description":"The longitude of this location.","example":-122.4194,"type":"number"},"postal_code":{"description":"The postal code of this location.","example":"94105","type":"string"},"source":{"anyOf":[{"$ref":"#/components/schemas/LocationSource"},{"nullable":true}],"description":"The source of the location data.","example":"system"},"spoofed":{"$ref":"#/components/schemas/LocationSpoofReason","description":"Indicates if the GPS data is spoofed.","example":"not_spoofed"},"state":{"description":"The state of this location.","example":"CA","type":"string"},"street_address":{"description":"The street address of this location.","example":"30 Main St","type":"string"},"timestamp":{"description":"A timestamp from the GPS data.","example":"2023-10-01T12:00:00Z","type":"string"},"updated_at":{"description":"The date/time the resource was last updated","example":"2020-05-01T21:44:40.000Z","format":"date-time","type":"string"}},"required":["accuracy","altitude","created_at","id","latitude","longitude","spoofed","timestamp","updated_at"],"type":"object"},"PopulatedTeam":{"additionalProperties":false,"properties":{"allow_image_deletes":{"default":true,"description":"Whether to allow app users to delete images during an inspection.","example":true,"type":"boolean"},"allow_list_item_capture_max":{"default":false,"description":"Whether app users should have a maximum limit of captures per list item.","example":true,"type":"boolean"},"app_success_message":{"description":"The message displayed to the customer on completion of the inspection.","type":"string"},"auto_finish_reminder_duration":{"description":"The amount of time until an auto-reminder is sent for incomplete inspections that have some photos/videos/question answers. `null` means auto-reminders are disabled. Any format supported by https://github.com/vercel/ms is valid.  Multiple reminders can be specified by separating them with a comma.","example":"12h,1d","type":"string"},"auto_reminder_duration":{"description":"The amount of time until an auto-reminder is sent for inspections without photos/videos/question answers. `null` means auto-reminders are disabled. Any format supported by https://github.com/vercel/ms is valid.  Multiple durations can be specified by separating them with a comma.","example":"12h,1d","type":"string"},"color_primary":{"description":"The primary hex color code used for branding in the app.","example":"#0F7EC1","type":"string"},"created_at":{"description":"The date/time the resource was created","example":"2020-05-01T21:44:40.000Z","format":"date-time","type":"string"},"created_by_user_id":{"description":"The id of the user that created this team.","example":123,"type":"number"},"custom_smart_link_url":{"description":"The custom URL to use when generating an inspection smart link. A short token is appended to the end as a hash (e.g., `#lx6pzExWILBMnhR`).","type":"string"},"customer_app_label":{"description":"The company name to display in the app.","example":"Quality Capital","type":"string"},"customer_item_label":{"description":"The word for an \"item\" in the context of the team.","example":"jewelry","type":"string"},"customer_support_label":{"description":"The label displayed for contacting support in the app.","example":"Contact Us","type":"string"},"customer_support_number":{"description":"The phone number attached to text messages for app users to contact for customer support.","example":"1 (516) 271-1526","format":"phone","type":"string"},"default_list_item_capture_max":{"description":"The maximum number of captures an app user can create for a list item in an inspection. Only used if allow_list_item_capture_max is `true`","example":20,"type":"number"},"distance_from_customer_address_threshold":{"description":"The distance (in meters) from the customer's address a photo/video can be taken before being flagged. `null` can be set to disable the flag.","example":1500,"type":"number"},"enabled_features":{"additionalProperties":false,"description":"A configuration object showing the the features that are enabled for this team.","properties":{"pdf_attachments":{"description":"Defines how the team wants PDF files attached to messages.","items":{"$ref":"#/components/schemas/PDFAttachmentSettings"},"type":"array"},"respond_to_text_messages":{"description":"Whether this team can respond to text messages from the Vision dashboard","example":true,"type":"boolean"},"web_camera":{"description":"Whether this team's inspections should be performed using the web camera.","example":true,"type":"boolean"}},"required":["respond_to_text_messages","web_camera"],"type":"object"},"gps_threshold":{"description":"The accuracy threshold that GPS coordinates must not exceed in meters.","example":1500,"type":"number"},"group_id_label":{"description":"The label to describe the identifier that the organization uses to reference the group in their system.","example":"Dealer ID","type":"string"},"groups":{"additionalProperties":false,"properties":{"address":{"description":"The address of the group","example":"7817 Ivanhoe Avenue, La Jolla, CA 92037","type":"string"},"id":{"description":"The id of the resource.","example":1843,"type":"number"},"name":{"description":"The name of the group","example":"Acura of La Jolla","type":"string"}},"required":["id","name"],"type":"object"},"id":{"description":"The id of the resource","example":1843,"type":"number"},"include_list":true,"inspection_types":{"items":{"additionalProperties":false,"description":"An inspection type with attached list and message template set data","properties":{"created_at":{"description":"The date/time the resource was created","example":"2020-05-01T21:44:40.000Z","format":"date-time","type":"string"},"created_by_member_user_id":{"description":"the id of the user who created this inspection type. References `users.id`","example":2343,"type":"number"},"custom_fields":{"description":"The custom fields associated with this Inspection Type with any custom field values","items":{"$ref":"#/components/schemas/PopulatedCustomField"},"type":"array"},"customer_unique_id_2":{"$ref":"#/components/schemas/UniqueID2","deprecated":true,"description":"The details about customer unique id 2. This field still works in v2 but for v3 you must use `custom_fields` instead.","example":{"entry_method":"ENTRY_METHOD_TEXT","is_enabled":true,"is_required":false,"label":"Custom ID 2"}},"customer_unique_id_label":{"deprecated":true,"description":"The entry method for the customer unique id field. This field still works in v2 but for v3 you must use `custom_fields` instead.","example":"Custom ID","type":"string"},"entry_method":{"$ref":"#/components/schemas/CustomFieldEntryMethods","deprecated":true,"description":"The label for the customer unique id field. This field still works in v2 but for v3 you must use `custom_fields` instead."},"id":{"description":"The id of the inspection type","example":1843,"type":"number"},"inspection_alert_config":{"$ref":"#/components/schemas/InspectionAlertConfig","description":"The alert configuration that is used by this inspection type."},"inspection_alert_config_id":{"description":"The id of the inspection alert configuration that is used by this inspection type. References `inspection_alert_configs.id`","example":539,"type":"number"},"inspection_ready_criteria_text":{"description":"Optional inspection-ready criteria text for this inspection type.","example":"Capture the VIN plate clearly and include a full odometer photo.","type":"string","nullable":true},"is_address_required":{"description":"Controls whether an address is required for the inspection or not","example":1000,"type":"boolean"},"is_deleted":true,"is_list_locked":{"description":"When true, the list associated with this inspection type cannot be changed","example":false,"type":"boolean"},"language":{"$ref":"#/components/schemas/LocalizationLanguages","description":"The IETF language tag for the intended language of the inspection. Non-customizable text in emails will use the language specified here."},"list":{"additionalProperties":false,"description":"The list associated with this Inspection Type","properties":{"created_at":{"description":"The date/time the resource was created","example":"2020-05-01T21:44:40.000Z","format":"date-time","type":"string"},"created_by_member_user_id":{"description":"The id of the user that created this list","example":609,"type":"number"},"groups":{"$ref":"#/components/schemas/ListItemGroups","description":"The groups of items in the list","example":{"grp1":{"name":"Group 2"}}},"id":{"description":"The id of the resource.","example":1843,"type":"number"},"inspection_id":{"description":"The id of the inspection that this list belongs to","example":6342,"type":"number"},"inspection_types":{"items":{"$ref":"#/components/schemas/InspectionType"},"type":"array"},"is_deleted":true,"items":{"items":{"$ref":"#/components/schemas/ListItem"},"type":"array"},"name":{"description":"The auto-generated name of the list.","example":"List for Inspection 3527","type":"string"},"organization_id":{"description":"The id of the organization that this list belongs to","example":52,"type":"number"},"team_id":{"description":"The id of the team that this list belongs to","example":66,"type":"number"},"type":{"$ref":"#/components/schemas/ListType","description":"The type of the list. Must be `EVENT_TEMPLATE`, `EVENT_INSTANCE`, `SURVEY_TEMPLATE`, or `SURVEY_INSTANCE`","example":"EVENT_TEMPLATE"},"updated_at":{"description":"The date/time the resource was last updated","example":"2020-05-01T21:44:40.000Z","format":"date-time","type":"string"}},"required":["created_at","id","inspection_types","is_deleted","items","name","organization_id","type","updated_at"],"type":"object"},"list_id":{"description":"The id of the list that is used by this inspection type. References `lists.id`","example":3345,"type":"number"},"max_distance_from_address_threshold":{"description":"the maximum distance away from the configured inspection address that an inspection can be completed in meters.","example":1000,"type":"number"},"message_template_set":{"$ref":"#/components/schemas/MessageTemplateSet","description":"The message template set associated with this Inspection Type"},"message_template_set_id":{"description":"The id of the message template set that is used by this inspection type. References `message_template_sets.id`","example":539,"type":"number"},"modified_by_member_user_id":{"description":"the id of the user who last modified this inspection type. References `users.id`","example":2343,"type":"number"},"name":{"description":"The name of the inspection type","example":"My Type","type":"string"},"organization_id":{"description":"the id of the organization that this inspection type belongs to. References `organizations.id`.","example":14,"type":"number"},"outcome_set":{"$ref":"#/components/schemas/OutcomeSet","description":"The outcome set that is used by this inspection type."},"outcome_set_id":{"description":"The id of the outcome set that is used by this inspection type. References `outcome_sets.id`","example":539,"type":"number"},"team_id":{"deprecated":true,"description":"the id of the team that this inspection type belongs to. References `teams.id`. Note that this is no longer used, and inspection types can now be associated with multiple teams","example":124,"type":"number"},"teams":{"description":"The the teams that use this inspection type.","items":{"additionalProperties":false,"properties":{"id":{"description":"The id of the resource","example":1843,"type":"number"},"name":{"description":"The name of the team.","example":"Claims","type":"string"}},"required":["id"],"type":"object"},"type":"array"},"updated_at":{"description":"The date/time the resource was last updated","example":"2020-05-01T21:44:40.000Z","format":"date-time","type":"string"},"use_single_name_field":{"description":"When true, there is only one name for the user to fill out rather than a separate first name and last name field","example":true,"type":"boolean"}},"required":["created_at","custom_fields","id","is_address_required","is_deleted","is_list_locked","language","list","message_template_set","message_template_set_id","name","organization_id","team_id","updated_at","use_single_name_field"],"type":"object"},"type":"array"},"is_deleted":true,"jwt_agent_admin_expiry":{"default":"72h","description":"The amount of time before an admin member's login token when switching teams expires. Any format supported by https://github.com/vercel/ms is valid.","example":"10h","type":"string"},"jwt_customer_expiry":{"default":"480h","description":"The amount of time before an inspection request token expires. Any format supported by https://github.com/vercel/ms is valid.","example":"120h","type":"string"},"list":{"items":{"additionalProperties":false,"description":"A list with attached list items and or inspection types","properties":{"created_at":{"description":"The date/time the resource was created","example":"2020-05-01T21:44:40.000Z","format":"date-time","type":"string"},"created_by_member_user_id":{"description":"The id of the user that created this list","example":609,"type":"number"},"groups":{"$ref":"#/components/schemas/ListItemGroups","description":"The groups of items in the list","example":{"grp1":{"name":"Group 2"}}},"id":{"description":"The id of the resource.","example":1843,"type":"number"},"inspection_id":{"description":"The id of the inspection that this list belongs to","example":6342,"type":"number"},"inspection_types":{"items":{"$ref":"#/components/schemas/InspectionType"},"type":"array"},"is_deleted":true,"items":{"items":{"$ref":"#/components/schemas/ListItem"},"type":"array"},"name":{"description":"The auto-generated name of the list.","example":"List for Inspection 3527","type":"string"},"organization_id":{"description":"The id of the organization that this list belongs to","example":52,"type":"number"},"team_id":{"description":"The id of the team that this list belongs to","example":66,"type":"number"},"type":{"$ref":"#/components/schemas/ListType","description":"The type of the list. Must be `EVENT_TEMPLATE`, `EVENT_INSTANCE`, `SURVEY_TEMPLATE`, or `SURVEY_INSTANCE`","example":"EVENT_TEMPLATE"},"updated_at":{"description":"The date/time the resource was last updated","example":"2020-05-01T21:44:40.000Z","format":"date-time","type":"string"}},"required":["created_at","id","inspection_types","is_deleted","items","name","organization_id","type","updated_at"],"type":"object"},"type":"array"},"name":{"description":"The name of the team.","example":"Claims","type":"string"},"notify_inspection_creator":{"description":"Whether to notify the member who created the inspection request of updates.","enum":[1,0],"example":1,"type":"number"},"organization_id":{"description":"The id of the organization this team belongs to.","example":123,"type":"number"},"phone_numbers":{"additionalProperties":{"type":"string"},"type":"object"},"ready_for_review_recipients":{"description":"A comma-separated list of email addresses to notify of inspection request updates.","example":"team@qualitylending.com,support@qualitylending.com","type":"string"},"send_methods":{"additionalProperties":false,"description":"The default methods to send the inspection request to the customer who will be completing the inspection.","properties":{"email":{"description":"Whether to send the inspection request via email.","example":true,"type":"boolean"},"text":{"description":"Whether to send the inspection request via text.","example":true,"type":"boolean"}},"required":["text","email"],"type":"object"},"send_methods_allowed":{"additionalProperties":false,"description":"This is an optional object specifying which send methods are allowed, all sending methods cannot all be disallowed","properties":{"email":{"default":true,"description":"Whether sending an inspection by email is allowed or not.","example":true,"type":"boolean"},"text":{"default":true,"description":"Whether sending an inspection by text message is allowed or not.","example":true,"type":"boolean"}},"required":["text","email"],"type":"object"},"shortname":{"description":"The combined URL-friendly name of the organization and team.","example":"quality-capital-claims","type":"string"},"slug":{"description":"The URL-friendly name of the team.","example":"claims","type":"string"},"status_callback_url":{"description":"The callback URL we send a request to on action / change in status of an inspection request","example":"https://api.qualitycapital.com/hooks/truepic","type":"string"},"theme_slug":{"description":"The url slug used to acquire the team's assets","example":"coca-cola","type":"string"},"updated_at":{"description":"The date/time the resource was last updated","example":"2020-05-01T21:44:40.000Z","format":"date-time","type":"string"},"video_enabled":true},"required":["created_at","created_by_user_id","id","inspection_types","is_deleted","jwt_member_admin_expiry","jwt_organization_expiry","organization_id","shortname","updated_at"],"type":"object"},"PopulatedTextMatchingSet":{"additionalProperties":false,"properties":{"can_delete":{"type":"boolean"},"created_at":{"description":"The date/time the resource was created","example":"2020-05-01T21:44:40.000Z","format":"date-time","type":"string"},"created_by_user_id":{"description":"The id of the user that created this text matching set.","example":894,"type":"number"},"id":{"description":"The id of the resource.","example":1843,"type":"number"},"is_deleted":true,"lists":{"items":{"additionalProperties":false,"properties":{"id":{"type":"number"},"name":{"type":"string"}},"required":["id","name"],"type":"object"},"type":"array"},"modified_by_user_id":{"description":"The id of the user that last edited this text matching set.","example":542,"type":"number"},"name":{"description":"The name of the text matching set","example":"Text Matching Set Name","type":"string"},"organization_id":{"description":"The id of the organization that owns this text matching set","example":532,"type":"number"},"strings":{"description":"The available options in this text matching set","example":["String 1","String 2","String 3"],"items":{"type":"string"},"type":"array"},"total_strings":{"type":"number"},"type":{"description":"The type of text matching set","example":"Serial Number","type":"string"},"updated_at":{"description":"The date/time the resource was last updated","example":"2020-05-01T21:44:40.000Z","format":"date-time","type":"string"}},"required":["can_delete","created_at","created_by_user_id","id","is_deleted","lists","name","organization_id","strings","total_strings","type","updated_at"],"type":"object"},"PostOrgAssetResult":{"additionalProperties":false,"description":"The response body for POST /org-asset/{assetType}/upload","properties":{"api_version":{"description":"The current version number of the Vision API","example":"3.0.0","type":"string"},"message":{"description":"The human readable-status of the response","example":"Success","type":"string"},"response_code":{"description":"The HTTP status code of the response","example":200,"type":"integer"},"result":{"additionalProperties":false,"properties":{"org_asset":{"type":"string"},"org_asset_square":{"type":"string"}},"required":["org_asset"],"type":"object"}},"required":["api_version","message","response_code","result"],"type":"object"},"PostTeamAssetByTypeResult":{"additionalProperties":false,"description":"The response body for POST /organization-teams/{teamId}/assets/{assetType}","properties":{"api_version":{"description":"The current version number of the Vision API","example":"3.0.0","type":"string"},"message":{"description":"The human readable-status of the response","example":"Success","type":"string"},"response_code":{"description":"The HTTP status code of the response","example":200,"type":"integer"},"result":{"description":"An array of urls for different resolutions of the uploaded asset","items":{"type":"string"},"type":"array"}},"required":["api_version","message","response_code","result"],"type":"object"},"Provider":{"additionalProperties":false,"description":"Auth0 IDP information","properties":{"connection":{"description":"Auth0 connection name","type":"string"},"isSocial":{"description":"Whether social login was used","type":"boolean"},"provider":{"description":"The type of provider used","type":"string"},"user_id":{"description":"The identifier for the user","type":"string"}},"required":["connection","isSocial","provider","user_id"],"type":"object"},"PsqlTimestamps":{"additionalProperties":false,"description":"A generic type for the fields applied to every table in the PSQL database.","properties":{"created_at":{"description":"The date/time the resource was created","example":"2020-05-01T21:44:40.000Z","format":"date-time","type":"string"},"updated_at":{"description":"The date/time the resource was last updated","example":"2020-05-01T21:44:40.000Z","format":"date-time","type":"string"}},"required":["created_at","updated_at"],"type":"object"},"QuestionTruepicExampleItem":{"additionalProperties":false,"properties":{"accepted":{"type":"boolean"},"confidence":{"type":"number","nullable":true},"consensus":{"type":"boolean","nullable":true},"reason":{"type":"string","nullable":true},"truepic_id":{"type":"number"},"url":{"type":"string"}},"required":["truepic_id","url","accepted","reason"],"type":"object"},"RecordWebsiteFormBearerActivityBody":{"additionalProperties":false,"properties":{"activity":{"type":"string"},"data":{"type":"object"}},"required":["activity"],"type":"object"},"RecordWebsiteFormBearerActivityResult":{"$ref":"#/components/schemas/ResponseData"},"RemoveUserResult":{"$ref":"#/components/schemas/CreateUserResult","description":"The response body for DELETE /users/{userId}"},"ResponseData":{"additionalProperties":false,"description":"The generic format for Vision API responses","properties":{"api_version":{"description":"The current version number of the Vision API","example":"3.0.0","type":"string"},"message":{"description":"The human readable-status of the response","example":"Success","type":"string"},"response_code":{"description":"The HTTP status code of the response","example":200,"type":"integer"}},"required":["response_code","message","api_version"],"type":"object"},"SendFinishReminderTextBody":{"$ref":"#/components/schemas/SendWelcomeTextBody","description":"The request body for PUT /text/reminder-to-finish"},"SendFinishReminderTextResult":{"$ref":"#/components/schemas/SendWelcomeTextResult","description":"The response body for PUT /text/reminder-to-finish"},"SendReleaseNotesEmailBody":{"additionalProperties":false,"description":"Request Body for POST /emails/release-notes","properties":{"body":{"description":"The text body of the email","type":"string"},"subject":{"description":"The subject for the email (also used as the header in the email content)","type":"string"},"superAdminsOnly":{"default":true,"description":"When true (or excluded), will only send the release notes email to Super Admins. If you want to send it to all Vision Dashboard users, you must explicitly set this to false","type":"boolean"}},"required":["subject","body","superAdminsOnly"],"type":"object"},"SendReminderTextBody":{"$ref":"#/components/schemas/SendWelcomeTextBody","description":"The request body for PUT /text/reminder"},"SendReminderTextResult":{"$ref":"#/components/schemas/SendWelcomeTextResult","description":"The response body for PUT /text/reminder"},"SendRequestFeatureEmailBody":{"additionalProperties":false,"description":"Request Body for POST /emails/request-feature","properties":{"feature_type":{"description":"The type of the requested feature","type":"string"}},"required":["feature_type"],"type":"object"},"SendRequestMoreTextBody":{"additionalProperties":false,"description":"The request body for PUT /text/request","properties":{"include_list":true,"inspection_id":{"description":"The id of the inspection","example":123,"type":"number"},"list":{"additionalProperties":false,"description":"A list with attached list items. This can be used to mark existing list items as incomplete, or to add new list items to the list, or both.","properties":{"groups":{"$ref":"#/components/schemas/ListItemGroups","description":"The groups of items in the list","example":{"grp1":{"name":"Group 2"}}},"items":{"description":"The list items describe prompts to the user for specific photos, videos, or questions during the inspection.","items":{"$ref":"#/components/schemas/ListItemPayload"},"type":"array"}},"required":["items"],"type":"object"},"message_supplement":{"description":"The message supplement (custom note) to be attached to the request text/email. Maximum length of 255 characters.","example":"Please complete the inspection in a timely manner.","maxLength":255,"type":"string"}},"required":["inspection_id"],"type":"object"},"SendRequestMoreTextResult":{"$ref":"#/components/schemas/SendWelcomeTextResult","description":"The response body for PUT /text/request"},"SendWebsiteFormBearerInspectionLinkBody":{"additionalProperties":false,"properties":{"method":{"enum":["text","email"],"type":"string"},"token":{"type":"string"}},"required":["method","token"],"type":"object"},"SendWebsiteFormBearerInspectionLinkResult":{"$ref":"#/components/schemas/ResponseData"},"SendWelcomeTextBody":{"additionalProperties":false,"description":"The request body for PUT /text/welcome","properties":{"inspection_id":{"description":"The id of the inspection","example":123,"type":"number"},"message_supplement":{"description":"The message supplement (custom note) to be attached to the request text/email. Maximum length of 255 characters.","example":"Please complete the inspection in a timely manner.","maxLength":255,"type":"string"}},"required":["inspection_id"],"type":"object"},"SendWelcomeTextResult":{"additionalProperties":false,"description":"The response body for PUT /text/welcome","properties":{"api_version":{"description":"The current version number of the Vision API","example":"3.0.0","type":"string"},"message":{"description":"The human readable-status of the response","example":"Success","type":"string"},"response_code":{"description":"The HTTP status code of the response","example":200,"type":"integer"},"result":{"description":"The Vision App link generated for the user","type":"string"}},"required":["api_version","message","response_code","result"],"type":"object"},"SerializedGroup":{"additionalProperties":false,"properties":{"address":{"description":"The address of the group","example":"7817 Ivanhoe Avenue, La Jolla, CA 92037","type":"string"},"id":{"description":"The id of the resource.","example":1843,"type":"number"},"name":{"description":"The name of the group","example":"Acura of La Jolla","type":"string"}},"required":["id","name"],"type":"object"},"SerializedUser":{"additionalProperties":false,"description":"A user object that's been serialized for the client. This is usually the object returned from the API and is used for client-side rendering.","properties":{"default_team":{"description":"The user's default team.","example":1843,"nullable":true},"email":{"description":"The email address of the user.","example":"kylorenxninja@potato.com","format":"email","type":"string"},"first_name":{"description":"The first name of the user.","example":"Kylo","type":"string"},"id":{"description":"The id of the user","example":1843,"type":"number"},"inspection_id":{"description":"The id of the inspection this user belongs to. Indicates this is a mobile app user performing an inspection. References `inspections.id`","example":2412,"type":"number"},"isMember":{"description":"Members can create inspections and review all inspections in assigned teams.","example":true,"type":"boolean"},"isMemberAdmin":{"description":"Administrators have full access to account settings. They can manage users, configure inspections, access reports, create inspections, and review all inspections.","example":false,"type":"boolean"},"isMemberOwnInspections":{"description":"These members can create inspections and review any inspection assigned to them.","example":true,"type":"boolean"},"isSuperAdmin":{"description":"Super Admins are for Truepic staff to setup and configure organizations.","example":false,"type":"boolean"},"isViewOnly":{"description":"These members can only view inspections in assigned teams.","example":false,"type":"boolean"},"last_name":{"description":"The last name of the user.","example":"Ren","type":"string"},"last_session_start":{"description":"The date/time the user last logged in","example":"2020-05-01T21:44:40.000Z","format":"date-time","type":"string"},"organization":{"additionalProperties":false,"description":"The user's organization information.","properties":{"auto_delete_customer_data_after_days":{"default":null,"description":"The number of days after which customer data (inspections, truepics, etc.) will be automatically deleted. A null value disables automatic deletion.","example":365,"type":"number","nullable":true},"id":{"description":"The id of the resource.","example":1843,"type":"number"},"is_mfa_required":true,"name":{"description":"The name of the organization.","example":"Quality Capital","type":"string"},"organization_slug":{"description":"The organization_slug of the organization used to access Vision.","example":"vision-test","type":"string"}},"required":["id","is_mfa_required"],"type":"object"},"organization_id":{"description":"The id of the organization this user belongs to.","example":117,"type":"number"},"phone_number":{"description":"The phone number of the user.","example":"5558675309","format":"phone","type":"string"},"roles":{"description":"A list of roles assigned to the user.","items":{"additionalProperties":false,"properties":{"id":{"description":"The id of the resource.","example":1843,"type":"number"},"id_internal":{"$ref":"#/components/schemas/VisionRole","description":"The code-parseable identifier of the role.","example":"VISION_AGENT_ADMIN"},"name":{"description":"The human-readable name of the role.","example":"Administrator","type":"string"}},"required":["id","id_internal","name"],"type":"object"},"type":"array"},"teams":{"description":"A list of all the teams that the user has been assigned to.","items":{"additionalProperties":false,"properties":{"id":{"description":"The id of the resource","example":1843,"type":"number"},"name":{"description":"The name of the team.","example":"Claims","type":"string"}},"required":["id"],"type":"object"},"type":"array"}},"required":["default_team","id","isMember","isMemberAdmin","isMemberOwnInspections","isSuperAdmin","isViewOnly","roles","teams"],"type":"object"},"SubmitItemDetailsToolCallParams":{"additionalProperties":false,"properties":{"auditor_notes":{"type":"string"},"criteria_results":{"items":{"additionalProperties":false,"properties":{"criterion":{"type":"string"},"criterion_id":{"type":"number"},"result":{"enum":["Yes","No","Unanswerable"],"type":"string"}},"required":["criterion_id","criterion","result"],"type":"object"},"type":"array"},"id":{"type":"number"},"original_instruction":{"type":"string"},"readiness_status":{"$ref":"#/components/schemas/DetailsReadinessStatus"},"reason":{"type":"string"},"type":{"enum":["Image","Video"],"type":"string"},"winning_set":{"type":"number","nullable":true}},"required":["id","type","reason","original_instruction","criteria_results","winning_set","readiness_status","auditor_notes"],"type":"object"},"SubmitOverviewToolCallParams":{"additionalProperties":false,"properties":{"readiness_status":{"$ref":"#/components/schemas/OverviewReadinessStatus"},"summary_text":{"type":"string"}},"required":["readiness_status","summary_text"],"type":"object"},"SubmitQADetailsToolCallParams":{"additionalProperties":false,"properties":{"auditor_notes":{"type":"string"},"id":{"type":"number"},"readiness_status":{"$ref":"#/components/schemas/DetailsReadinessStatus"}},"required":["id","readiness_status","auditor_notes"],"type":"object"},"SuccessfulCreationResponseData":{"additionalProperties":false,"properties":{"api_version":{"description":"The current version number of the Vision API","example":"3.0.0","type":"string"},"id":{"description":"The ID of the newly created resource","example":5,"type":"number"},"message":{"description":"The human readable-status of the response","example":"Success","type":"string"},"response_code":{"description":"The HTTP status code of the response","example":200,"type":"integer"}},"required":["api_version","id","message","response_code"],"type":"object"},"Team":{"additionalProperties":false,"description":"A Team that exists under an organization in Vision that sends out inspection requests","properties":{"allow_image_deletes":{"default":true,"description":"Whether to allow app users to delete images during an inspection.","example":true,"type":"boolean"},"allow_list_item_capture_max":{"default":false,"description":"Whether app users should have a maximum limit of captures per list item.","example":true,"type":"boolean"},"app_success_message":{"description":"The message displayed to the customer on completion of the inspection.","type":"string"},"auto_finish_reminder_duration":{"description":"The amount of time until an auto-reminder is sent for incomplete inspections that have some photos/videos/question answers. `null` means auto-reminders are disabled. Any format supported by https://github.com/vercel/ms is valid.  Multiple reminders can be specified by separating them with a comma.","example":"12h,1d","type":"string"},"auto_reminder_duration":{"description":"The amount of time until an auto-reminder is sent for inspections without photos/videos/question answers. `null` means auto-reminders are disabled. Any format supported by https://github.com/vercel/ms is valid.  Multiple durations can be specified by separating them with a comma.","example":"12h,1d","type":"string"},"color_primary":{"description":"The primary hex color code used for branding in the app.","example":"#0F7EC1","type":"string"},"created_at":{"description":"The date/time the resource was created","example":"2020-05-01T21:44:40.000Z","format":"date-time","type":"string"},"created_by_user_id":{"description":"The id of the user that created this team.","example":123,"type":"number"},"custom_smart_link_url":{"description":"The custom URL to use when generating an inspection smart link. A short token is appended to the end as a hash (e.g., `#lx6pzExWILBMnhR`).","type":"string"},"customer_app_label":{"description":"The company name to display in the app.","example":"Quality Capital","type":"string"},"customer_item_label":{"description":"The word for an \"item\" in the context of the team.","example":"jewelry","type":"string"},"customer_support_label":{"description":"The label displayed for contacting support in the app.","example":"Contact Us","type":"string"},"customer_support_number":{"description":"The phone number attached to text messages for app users to contact for customer support.","example":"1 (516) 271-1526","format":"phone","type":"string"},"default_list_item_capture_max":{"description":"The maximum number of captures an app user can create for a list item in an inspection. Only used if allow_list_item_capture_max is `true`","example":20,"type":"number"},"distance_from_customer_address_threshold":{"description":"The distance (in meters) from the customer's address a photo/video can be taken before being flagged. `null` can be set to disable the flag.","example":1500,"type":"number"},"enabled_features":{"additionalProperties":false,"description":"A configuration object showing the the features that are enabled for this team.","properties":{"pdf_attachments":{"description":"Defines how the team wants PDF files attached to messages.","items":{"$ref":"#/components/schemas/PDFAttachmentSettings"},"type":"array"},"respond_to_text_messages":{"description":"Whether this team can respond to text messages from the Vision dashboard","example":true,"type":"boolean"},"web_camera":{"description":"Whether this team's inspections should be performed using the web camera.","example":true,"type":"boolean"}},"required":["respond_to_text_messages","web_camera"],"type":"object"},"gps_threshold":{"description":"The accuracy threshold that GPS coordinates must not exceed in meters.","example":1500,"type":"number"},"group_id_label":{"description":"The label to describe the identifier that the organization uses to reference the group in their system.","example":"Dealer ID","type":"string"},"id":{"description":"The id of the resource","example":1843,"type":"number"},"include_list":true,"is_deleted":true,"jwt_agent_admin_expiry":{"default":"72h","description":"The amount of time before an admin member's login token when switching teams expires. Any format supported by https://github.com/vercel/ms is valid.","example":"10h","type":"string"},"jwt_customer_expiry":{"default":"480h","description":"The amount of time before an inspection request token expires. Any format supported by https://github.com/vercel/ms is valid.","example":"120h","type":"string"},"name":{"description":"The name of the team.","example":"Claims","type":"string"},"notify_inspection_creator":{"description":"Whether to notify the member who created the inspection request of updates.","enum":[1,0],"example":1,"type":"number"},"organization_id":{"description":"The id of the organization this team belongs to.","example":123,"type":"number"},"ready_for_review_recipients":{"description":"A comma-separated list of email addresses to notify of inspection request updates.","example":"team@qualitylending.com,support@qualitylending.com","type":"string"},"send_methods":{"additionalProperties":false,"description":"The default methods to send the inspection request to the customer who will be completing the inspection.","properties":{"email":{"description":"Whether to send the inspection request via email.","example":true,"type":"boolean"},"text":{"description":"Whether to send the inspection request via text.","example":true,"type":"boolean"}},"required":["text","email"],"type":"object"},"send_methods_allowed":{"additionalProperties":false,"description":"This is an optional object specifying which send methods are allowed, all sending methods cannot all be disallowed","properties":{"email":{"default":true,"description":"Whether sending an inspection by email is allowed or not.","example":true,"type":"boolean"},"text":{"default":true,"description":"Whether sending an inspection by text message is allowed or not.","example":true,"type":"boolean"}},"required":["text","email"],"type":"object"},"shortname":{"description":"The combined URL-friendly name of the organization and team.","example":"quality-capital-claims","type":"string"},"slug":{"description":"The URL-friendly name of the team.","example":"claims","type":"string"},"status_callback_url":{"description":"The callback URL we send a request to on action / change in status of an inspection request","example":"https://api.qualitycapital.com/hooks/truepic","type":"string"},"theme_slug":{"description":"The url slug used to acquire the team's assets","example":"coca-cola","type":"string"},"updated_at":{"description":"The date/time the resource was last updated","example":"2020-05-01T21:44:40.000Z","format":"date-time","type":"string"},"video_enabled":true},"required":["created_at","created_by_user_id","id","is_deleted","jwt_member_admin_expiry","jwt_organization_expiry","organization_id","shortname","updated_at"],"type":"object"},"TeamPayload":{"additionalProperties":false,"properties":{"allow_image_deletes":{"default":true,"description":"Whether to allow app users to delete images during an inspection.","example":true,"type":"boolean"},"allow_list_item_capture_max":{"default":false,"description":"Whether app users should have a maximum limit of captures per list item.","example":true,"type":"boolean"},"app_success_message":{"description":"The message displayed to the customer on completion of the inspection.","type":"string"},"auto_finish_reminder_duration":{"description":"The amount of time until an auto-reminder is sent for incomplete inspections that have some photos/videos/question answers. `null` means auto-reminders are disabled. Any format supported by https://github.com/vercel/ms is valid.  Multiple reminders can be specified by separating them with a comma.","example":"12h,1d","type":"string"},"auto_reminder_duration":{"description":"The amount of time until an auto-reminder is sent for inspections without photos/videos/question answers. `null` means auto-reminders are disabled. Any format supported by https://github.com/vercel/ms is valid.  Multiple durations can be specified by separating them with a comma.","example":"12h,1d","type":"string"},"color_primary":{"description":"The primary hex color code used for branding in the app.","example":"#0F7EC1","type":"string"},"created_at":{"description":"The date/time the resource was created","example":"2020-05-01T21:44:40.000Z","format":"date-time","type":"string"},"created_by_user_id":{"description":"The id of the user that created this team.","example":123,"type":"number"},"custom_smart_link_url":{"description":"The custom URL to use when generating an inspection smart link. A short token is appended to the end as a hash (e.g., `#lx6pzExWILBMnhR`).","type":"string"},"customer_app_label":{"description":"The company name to display in the app.","example":"Quality Capital","type":"string"},"customer_item_label":{"description":"The word for an \"item\" in the context of the team.","example":"jewelry","type":"string"},"customer_support_label":{"description":"The label displayed for contacting support in the app.","example":"Contact Us","type":"string"},"customer_support_number":{"description":"The phone number attached to text messages for app users to contact for customer support.","example":"1 (516) 271-1526","format":"phone","type":"string"},"default_list_item_capture_max":{"description":"The maximum number of captures an app user can create for a list item in an inspection. Only used if allow_list_item_capture_max is `true`","example":20,"type":"number"},"distance_from_customer_address_threshold":{"description":"The distance (in meters) from the customer's address a photo/video can be taken before being flagged. `null` can be set to disable the flag.","example":1500,"type":"number"},"enabled_features":{"additionalProperties":false,"description":"A configuration object showing the the features that are enabled for this team.","properties":{"pdf_attachments":{"description":"Defines how the team wants PDF files attached to messages.","items":{"$ref":"#/components/schemas/PDFAttachmentSettings"},"type":"array"},"respond_to_text_messages":{"description":"Whether this team can respond to text messages from the Vision dashboard","example":true,"type":"boolean"},"web_camera":{"description":"Whether this team's inspections should be performed using the web camera.","example":true,"type":"boolean"}},"required":["respond_to_text_messages","web_camera"],"type":"object"},"gps_threshold":{"description":"The accuracy threshold that GPS coordinates must not exceed in meters.","example":1500,"type":"number"},"group_id_label":{"description":"The label to describe the identifier that the organization uses to reference the group in their system.","example":"Dealer ID","type":"string"},"id":{"description":"The id of the resource","example":1843,"type":"number"},"include_list":true,"is_deleted":true,"jwt_agent_admin_expiry":{"default":"72h","description":"The amount of time before an admin member's login token when switching teams expires. Any format supported by https://github.com/vercel/ms is valid.","example":"10h","type":"string"},"jwt_customer_expiry":{"default":"480h","description":"The amount of time before an inspection request token expires. Any format supported by https://github.com/vercel/ms is valid.","example":"120h","type":"string"},"name":{"description":"The name of the team.","example":"Claims","type":"string"},"notify_inspection_creator":{"description":"Whether to notify the member who created the inspection request of updates.","enum":[1,0],"example":1,"type":"number"},"organization_id":{"description":"The id of the organization this team belongs to.","example":123,"type":"number"},"phone_numbers":{"additionalProperties":{"type":"string"},"type":"object"},"ready_for_review_recipients":{"description":"A comma-separated list of email addresses to notify of inspection request updates.","example":"team@qualitylending.com,support@qualitylending.com","type":"string"},"send_methods":{"additionalProperties":false,"description":"The default methods to send the inspection request to the customer who will be completing the inspection.","properties":{"email":{"description":"Whether to send the inspection request via email.","example":true,"type":"boolean"},"text":{"description":"Whether to send the inspection request via text.","example":true,"type":"boolean"}},"required":["text","email"],"type":"object"},"send_methods_allowed":{"additionalProperties":false,"description":"This is an optional object specifying which send methods are allowed, all sending methods cannot all be disallowed","properties":{"email":{"default":true,"description":"Whether sending an inspection by email is allowed or not.","example":true,"type":"boolean"},"text":{"default":true,"description":"Whether sending an inspection by text message is allowed or not.","example":true,"type":"boolean"}},"required":["text","email"],"type":"object"},"shortname":{"description":"The combined URL-friendly name of the organization and team.","example":"quality-capital-claims","type":"string"},"slug":{"description":"The URL-friendly name of the team.","example":"claims","type":"string"},"status_callback_url":{"description":"The callback URL we send a request to on action / change in status of an inspection request","example":"https://api.qualitycapital.com/hooks/truepic","type":"string"},"theme_slug":{"description":"The url slug used to acquire the team's assets","example":"coca-cola","type":"string"},"updated_at":{"description":"The date/time the resource was last updated","example":"2020-05-01T21:44:40.000Z","format":"date-time","type":"string"},"video_enabled":true},"type":"object"},"TeamWebhook":{"additionalProperties":false,"description":"A configuration object for a webhook triggered for a team when an inspection is updated","properties":{"created_at":{"description":"The date/time the resource was created","example":"2020-05-01T21:44:40.000Z","format":"date-time","type":"string"},"custom_headers":{"anyOf":[{"type":"object"},{"nullable":true}],"description":"An object containing any custom headers that should be sent in the webhook POST request. If you want a unique request id header to be sent, create a header with a value of \"{{ UUID }}\". When the webhook is sent, this will be replaced with a unique UUID for each request.","example":{"x-api-resource":"truepic","x-request-id":"{{ UUID }}"}},"disabled_at":{"description":"The timestamp when this webhook was disabled.","example":"2023-06-01 17:12:20.097233+00","format":"date-time","type":"string","nullable":true},"id":{"description":"The id of the resource.","example":1843,"type":"number"},"mutual_tls":{"default":false,"description":"Whether or not to use Mutual TLS when sending the webhook POST request.  This is an additional security measure that requires the receiving service to present a valid TLS certificate and to verify our API server's certificate before accepting the request.","example":false,"type":"boolean"},"organization_id":{"description":"The id of the organization.","example":1,"type":"number"},"secret_encrypted":{"description":"The encrypted string sent with webhook POST requests. Used for authentication with the organization's receiving service.","example":"WMHadsfgYQ+348BEPcoyucKSaerwgq34gq34grstXp62P0Svn5VyEAGCKXM+CKcaw==","type":"string","nullable":true},"team_id":{"description":"The id of the team. Each team can have only one webhook.","example":12,"type":"number"},"updated_at":{"description":"The date/time the resource was last updated","example":"2020-05-01T21:44:40.000Z","format":"date-time","type":"string"},"url":{"description":"The url that the webhook POST request is sent to.","example":"https://webhook.site/7a126f8d-6f8d-486f-8116-c92088360fe7","format":"url","type":"string"},"vision_api_version":{"$ref":"#/components/schemas/VisionAPIVersion","default":"v3","description":"The API version used to send the webhook POST request. Determines the terminology (v2 or v3) sent.","example":"v3"}},"required":["created_at","id","organization_id","team_id","updated_at","url"],"type":"object"},"TeamWebhookDBPayload":{"additionalProperties":false,"properties":{"custom_headers":{"anyOf":[{"type":"object"},{"nullable":true}],"description":"An object containing any custom headers that should be sent in the webhook POST request. If you want a unique request id header to be sent, create a header with a value of \"{{ UUID }}\". When the webhook is sent, this will be replaced with a unique UUID for each request.","example":{"x-api-resource":"truepic","x-request-id":"{{ UUID }}"}},"is_disabled":{"description":"Whether or not the webhook should be disabled.  If set to true, the webhook will be disabled and no longer send POST requests. If set to false, the webhook will be enabled and will send POST requests.  If you omit this field, the webhook will not change its disabled state.","example":false,"type":"boolean"},"mutual_tls":{"default":false,"description":"Whether or not to use Mutual TLS when sending the webhook POST request.  This is an additional security measure that requires the receiving service to present a valid TLS certificate and to verify our API server's certificate before accepting the request.","example":false,"type":"boolean"},"organization_id":{"description":"The id of the organization.","example":1,"type":"number"},"secret":{"description":"The secret used for authenticating the webhooks. When we send webhooks to your endpoint, we will add a truepic-signature header to those requests that we generate using this secret. When your endpoint receives a webhook POST request, you can then verify that the request was signed with this secret to ensure that the request is from us. If you want to remove the secret, set this to null. If you want to set a new secret, provide the new secret string. If you don't want to change the secret, omit this field.","example":"some-secret-string","type":"string","nullable":true},"team_id":{"description":"The id of the team. Each team can have only one webhook.","example":12,"type":"number"},"url":{"description":"The url that the webhook POST request is sent to.","example":"https://webhook.site/7a126f8d-6f8d-486f-8116-c92088360fe7","format":"url","type":"string"},"vision_api_version":{"$ref":"#/components/schemas/VisionAPIVersion","default":"v3","description":"The API version used to send the webhook POST request. Determines the terminology (v2 or v3) sent.","example":"v3"}},"required":["organization_id","team_id","url"],"type":"object"},"TeamWebhookExpanded":{"additionalProperties":false,"properties":{"created_at":{"description":"The date/time the resource was created","example":"2020-05-01T21:44:40.000Z","format":"date-time","type":"string"},"custom_headers":{"anyOf":[{"type":"object"},{"nullable":true}],"description":"An object containing any custom headers that should be sent in the webhook POST request. If you want a unique request id header to be sent, create a header with a value of \"{{ UUID }}\". When the webhook is sent, this will be replaced with a unique UUID for each request.","example":{"x-api-resource":"truepic","x-request-id":"{{ UUID }}"}},"disabled_at":{"description":"The timestamp when this webhook was disabled.","example":"2023-06-01 17:12:20.097233+00","format":"date-time","type":"string","nullable":true},"has_secret":{"description":"Whether or not the webhook has a secret.","example":true,"type":"boolean"},"id":{"description":"The id of the resource.","example":1843,"type":"number"},"is_disabled":{"description":"Whether or not the webhook should be disabled.  If set to true, the webhook will be disabled and no longer send POST requests. If set to false, the webhook will be enabled and will send POST requests.  If you omit this field, the webhook will not change its disabled state.","example":false,"type":"boolean"},"mutual_tls":{"default":false,"description":"Whether or not to use Mutual TLS when sending the webhook POST request.  This is an additional security measure that requires the receiving service to present a valid TLS certificate and to verify our API server's certificate before accepting the request.","example":false,"type":"boolean"},"organization_id":{"description":"The id of the organization.","example":1,"type":"number"},"secret":{"description":"The secret used for authenticating the webhooks. When we send webhooks to your endpoint, we will add a truepic-signature header to those requests that we generate using this secret. When your endpoint receives a webhook POST request, you can then verify that the request was signed with this secret to ensure that the request is from us. If you want to remove the secret, set this to null. If you want to set a new secret, provide the new secret string. If you don't want to change the secret, omit this field.","example":"some-secret-string","type":"string","nullable":true},"secret_encrypted":{"description":"The encrypted string sent with webhook POST requests. Used for authentication with the organization's receiving service.","example":"WMHadsfgYQ+348BEPcoyucKSaerwgq34gq34grstXp62P0Svn5VyEAGCKXM+CKcaw==","type":"string","nullable":true},"team_id":{"description":"The id of the team. Each team can have only one webhook.","example":12,"type":"number"},"updated_at":{"description":"The date/time the resource was last updated","example":"2020-05-01T21:44:40.000Z","format":"date-time","type":"string"},"url":{"description":"The url that the webhook POST request is sent to.","example":"https://webhook.site/7a126f8d-6f8d-486f-8116-c92088360fe7","format":"url","type":"string"},"vision_api_version":{"$ref":"#/components/schemas/VisionAPIVersion","default":"v3","description":"The API version used to send the webhook POST request. Determines the terminology (v2 or v3) sent.","example":"v3"}},"required":["created_at","id","organization_id","team_id","updated_at","url"],"type":"object"},"TeamWebhookPayload":{"additionalProperties":false,"properties":{"custom_headers":{"anyOf":[{"type":"object"},{"nullable":true}],"description":"An object containing any custom headers that should be sent in the webhook POST request. If you want a unique request id header to be sent, create a header with a value of \"{{ UUID }}\". When the webhook is sent, this will be replaced with a unique UUID for each request.","example":{"x-api-resource":"truepic","x-request-id":"{{ UUID }}"}},"is_disabled":{"description":"Whether or not the webhook should be disabled.  If set to true, the webhook will be disabled and no longer send POST requests. If set to false, the webhook will be enabled and will send POST requests.  If you omit this field, the webhook will not change its disabled state.","example":false,"type":"boolean"},"mutual_tls":{"default":false,"description":"Whether or not to use Mutual TLS when sending the webhook POST request.  This is an additional security measure that requires the receiving service to present a valid TLS certificate and to verify our API server's certificate before accepting the request.","example":false,"type":"boolean"},"secret":{"description":"The secret used for authenticating the webhooks. When we send webhooks to your endpoint, we will add a truepic-signature header to those requests that we generate using this secret. When your endpoint receives a webhook POST request, you can then verify that the request was signed with this secret to ensure that the request is from us. If you want to remove the secret, set this to null. If you want to set a new secret, provide the new secret string. If you don't want to change the secret, omit this field.","example":"some-secret-string","type":"string","nullable":true},"team_id":{"description":"The id of the team. Each team can have only one webhook.","example":12,"type":"number"},"url":{"description":"The url that the webhook POST request is sent to.","example":"https://webhook.site/7a126f8d-6f8d-486f-8116-c92088360fe7","format":"url","type":"string"},"vision_api_version":{"$ref":"#/components/schemas/VisionAPIVersion","default":"v3","description":"The API version used to send the webhook POST request. Determines the terminology (v2 or v3) sent.","example":"v3"}},"required":["team_id","url"],"type":"object"},"TeamWebhookResponse":{"additionalProperties":false,"properties":{"created_at":{"description":"The date/time the resource was created","example":"2020-05-01T21:44:40.000Z","format":"date-time","type":"string"},"custom_headers":{"anyOf":[{"type":"object"},{"nullable":true}],"description":"An object containing any custom headers that should be sent in the webhook POST request. If you want a unique request id header to be sent, create a header with a value of \"{{ UUID }}\". When the webhook is sent, this will be replaced with a unique UUID for each request.","example":{"x-api-resource":"truepic","x-request-id":"{{ UUID }}"}},"disabled_at":{"description":"The timestamp when this webhook was disabled.","example":"2023-06-01 17:12:20.097233+00","format":"date-time","type":"string","nullable":true},"has_secret":{"description":"Whether or not the webhook has a secret.","example":true,"type":"boolean"},"id":{"description":"The id of the resource.","example":1843,"type":"number"},"is_disabled":{"description":"Whether or not the webhook should be disabled.  If set to true, the webhook will be disabled and no longer send POST requests. If set to false, the webhook will be enabled and will send POST requests.  If you omit this field, the webhook will not change its disabled state.","example":false,"type":"boolean"},"mutual_tls":{"default":false,"description":"Whether or not to use Mutual TLS when sending the webhook POST request.  This is an additional security measure that requires the receiving service to present a valid TLS certificate and to verify our API server's certificate before accepting the request.","example":false,"type":"boolean"},"organization_id":{"description":"The id of the organization.","example":1,"type":"number"},"team_id":{"description":"The id of the team. Each team can have only one webhook.","example":12,"type":"number"},"updated_at":{"description":"The date/time the resource was last updated","example":"2020-05-01T21:44:40.000Z","format":"date-time","type":"string"},"url":{"description":"The url that the webhook POST request is sent to.","example":"https://webhook.site/7a126f8d-6f8d-486f-8116-c92088360fe7","format":"url","type":"string"},"vision_api_version":{"$ref":"#/components/schemas/VisionAPIVersion","default":"v3","description":"The API version used to send the webhook POST request. Determines the terminology (v2 or v3) sent.","example":"v3"}},"required":["id","organization_id","team_id","url","created_at","updated_at"],"type":"object"},"TestResult":{"description":"The possible results of a single test on a Truepic (blurriness, geo, ris, etc.)","enum":["P","W","F","U","N"],"type":"string"},"TextMatchingExpectedValues":{"items":{"additionalProperties":false,"properties":{"text_matching_set":{"$ref":"#/components/schemas/TextMatchingSetExpectedValues","description":"The text matching set to compare against.\n\nNote this is not set when the text matching set is selected, but it is returned in the response."},"text_matching_set_id":{"description":"The id of the text matching set","example":1,"type":"number"}},"required":["text_matching_set_id"],"type":"object"},"type":"array"},"TextMatchingSet":{"additionalProperties":false,"description":"A set of possible strings that the content analysis will look for in the OCR result *","properties":{"created_at":{"description":"The date/time the resource was created","example":"2020-05-01T21:44:40.000Z","format":"date-time","type":"string"},"created_by_user_id":{"description":"The id of the user that created this text matching set.","example":894,"type":"number"},"id":{"description":"The id of the resource.","example":1843,"type":"number"},"is_deleted":true,"modified_by_user_id":{"description":"The id of the user that last edited this text matching set.","example":542,"type":"number"},"name":{"description":"The name of the text matching set","example":"Text Matching Set Name","type":"string"},"organization_id":{"description":"The id of the organization that owns this text matching set","example":532,"type":"number"},"strings":{"description":"The available options in this text matching set","example":["String 1","String 2","String 3"],"items":{"type":"string"},"type":"array"},"type":{"description":"The type of text matching set","example":"Serial Number","type":"string"},"updated_at":{"description":"The date/time the resource was last updated","example":"2020-05-01T21:44:40.000Z","format":"date-time","type":"string"}},"required":["created_at","created_by_user_id","id","is_deleted","name","organization_id","strings","type","updated_at"],"type":"object"},"TextMatchingSetExpectedValues":{"additionalProperties":false,"properties":{"id":{"description":"The id of the resource.","example":1843,"type":"number"},"name":{"description":"The name of the text matching set","example":"Text Matching Set Name","type":"string"},"strings":{"description":"The available options in this text matching set","example":["String 1","String 2","String 3"],"items":{"type":"string"},"type":"array"},"total_strings":{"type":"number"},"type":{"description":"The type of text matching set","example":"Serial Number","type":"string"}},"required":["id","name","type","total_strings","strings"],"type":"object"},"TimelineAction":{"additionalProperties":false,"description":"An action that occurred on an inspection. These appear in the inspection timeline and some will trigger webhooks for the team associated with the inspection.","properties":{"created_at":{"description":"The date/time the resource was created","example":"2020-05-01T21:44:40.000Z","format":"date-time","type":"string"},"customer_user_id":{"description":"The id of the app user that performed this action","example":4335,"type":"number"},"data":{"additionalProperties":false,"description":"An object containing any additional data related to the action.","properties":{"flags":{"additionalProperties":false,"description":"The flags and comment applied for the ACTION_DEVICE_FLAGS_CHANGED activity","properties":{"comment":{"description":"The comment to apply to the activity log for this flag action.","type":"string"},"flags":{"description":"The complete list of flags to apply to the device for this inspection. This will update the list of flags to match this array by adding and/or removing any existing flags.","items":{"$ref":"#/components/schemas/DeviceFlagType"},"type":"array"}},"required":["flags"],"type":"object"},"is_details_full_message":{"description":"Whether the full message was sent","example":true,"type":"boolean"},"list_item_id":{"description":"The id of the associated list item","example":12345,"type":"number"},"location":{"$ref":"#/components/schemas/LensActivityLocationData","description":"An optional location associated with the action"},"message_id":{"description":"The Sendgrid email message id of the associated message","example":"DGnO3FNol23452ewf9v-7786453638cc-xx435l-1-646B123C-53.0","type":"string"},"reason":{"description":"If the action was triggered by a Lens activity, this will contain details about the activity","example":"timestamp_old","type":"string"},"tags":{"description":"An array of tag strings describing an activity","items":{"type":"string"},"type":"array"},"truepic_id":{"description":"The id of the associated Truepic","example":12345,"type":"number"}},"type":"object"},"details":{"description":"Any additional information, such as a member's custom message or more descriptive text.","type":"number","nullable":true},"device_fingerprint_details_request_id":{"description":"The id of the device fingerprint record","type":"string"},"device_id":{"description":"The id of the device record","example":1843,"type":"number"},"device_validation_status":{"$ref":"#/components/schemas/DeviceValidationStatus","description":"The determined status of the fingerprint data.","example":"VALID"},"id":{"description":"The id of the resource.","example":1843,"type":"number"},"inspection_id":{"description":"The id of the inspection this action occurred on","example":4335,"type":"number"},"is_deleted":true,"location_id":{"description":"The id of the location record","example":12345,"type":"number"},"member_user_id":{"description":"The id of the dashboard user that performed this action","example":4335,"type":"number"},"meta":{"description":"Any meta information, such as the URL when a new smart link is generated.","type":"string"},"timeline_action_type_id":{"description":"The id of the action type","example":12,"type":"number"},"updated_at":{"description":"The date/time the resource was last updated","example":"2020-05-01T21:44:40.000Z","format":"date-time","type":"string"}},"required":["created_at","id","inspection_id","updated_at"],"type":"object"},"TimelineActionType":{"additionalProperties":false,"description":"A type of action that can occur an inspection.","properties":{"created_at":{"description":"The date/time the resource was created","example":"2020-05-01T21:44:40.000Z","format":"date-time","type":"string"},"id":{"description":"The id of the resource.","example":1843,"type":"number"},"id_internal":{"description":"The code-parseable identifier of the action.","example":"ACTION_INSPECTION_CREATED","type":"string"},"name":{"description":"The human-readable name of the action.","example":"Inspection created","type":"string"},"updated_at":{"description":"The date/time the resource was last updated","example":"2020-05-01T21:44:40.000Z","format":"date-time","type":"string"}},"required":["created_at","id","updated_at"],"type":"object"},"Truepic":{"additionalProperties":false,"description":"A photo or video (if enabled for the organization) from an inspection request.","properties":{"accuracy":{"description":"The accuracy of the GPS coordinates in meters.","example":165,"type":"number"},"ai_analysis_done":{"description":"Whether the AI analysis test is complete for this Truepic.","example":true,"type":"boolean"},"ai_analysis_status":{"$ref":"#/components/schemas/TestResult","description":"The status of an AI analysis test on this Truepic.","example":"P"},"archived":true,"blockchain_status":{"$ref":"#/components/schemas/TestResult","description":"The status of a blockchain test on this Truepic.","example":"P"},"capture_integrity_status":{"$ref":"#/components/schemas/TestResult","description":"The status of a capture integrity test on this Truepic.","example":"P"},"city":{"description":"The city where the photo/video was taken, based on GPS coordinates.","example":"La Jolla","type":"string"},"comment":{"description":"The comment attached to the Truepic","example":"Hello","type":"string"},"container_id":{"description":"The id of the container this Truepic is part of","example":10,"type":"number"},"content_analysis_status":{"$ref":"#/components/schemas/TestResult","description":"The status of a content analysis test on this Truepic.","example":"P"},"created_at":{"description":"The date/time the resource was created","example":"2020-05-01T21:44:40.000Z","format":"date-time","type":"string"},"datetime_status":{"$ref":"#/components/schemas/TestResult","description":"The status of a datetime test on this Truepic.","example":"P"},"device_integrity_status":{"$ref":"#/components/schemas/TestResult","description":"The status of a device integrity test on this Truepic.","example":"P"},"device_time":{"description":"The date/time of the device when the photo/video was captured. ISO 8601 format.","example":"2018-08-06T15:29:47.000Z","format":"date-time","type":"string"},"duration":{"description":"The video duration of this Truepic, if it is a video.","example":"0:00:30","type":"string"},"formatted_address":{"description":"The formatted address where the photo/video was taken, based on GPS coordinates.","example":"7817 Ivanhoe Avenue, La Jolla, CA 92037","type":"string"},"geolocation_status":{"$ref":"#/components/schemas/TestResult","description":"The status of a geolocation test on this Truepic.","example":"P"},"gps_ts":{"description":"The unix timestamp of the GPS where the capture was taken.","example":"555262184.034417","type":"string"},"heading":{"description":"The direction the device was facing when the photo/video was taken. `0.0` is magnetic north.","example":220.48,"type":"number"},"id":{"description":"The id of the resource.","example":1843,"type":"number"},"image":{"description":"A URL to a scaled-down version of the image.","example":"https://d3tbfdtihunht2.cloudfront.net/qfzkoxugjn_f.jpg?...","type":"string"},"inspection_id":{"description":"The id of the inspection this Truepic is associated with.","example":6522,"type":"number"},"internal_note":{"description":"An internal note by a dashboard user attached to this Truepic","example":"Looks damaged.","type":"string"},"is_deleted":true,"is_rooted":true,"lat":{"description":"The GPS latitude where the photo/video was taken.","example":"33.5565051716316","type":"string"},"lens_transfer_done":true,"lng":{"description":"The GPS longitude where the photo/video was taken.","example":"33.5565051716316","type":"string"},"local_ts":{"description":"The localized timestamp of the capture of the Truepic","example":"6/14/23 4:02pm EDT","type":"string"},"make":{"description":"The make of the device that captured this Truepic","example":"Apple","type":"string"},"md5_hash":{"description":"The md5 hash of the Truepic signature","example":"900edbargawerfgaerwgd8a2c76ab2","type":"string"},"media_digest":{"description":"The media digest of the Truepic","example":"001183fw23f2w3fwergdsghr2q35aaada5wefw234f23rfw23wec13af441e6b","type":"string"},"model":{"description":"The model of the device that captured this Truepic","example":"iPhone 7","type":"string"},"object_detection_done":{"description":"Whether the object detection test is complete for this Truepic.","example":true,"type":"boolean"},"object_detection_status":{"$ref":"#/components/schemas/TestResult","description":"The status of an object detection test on this Truepic.","example":"P"},"original_image":{"description":"A URL to the original image.","example":"https://d3tbfdtihunht2.cloudfront.net/qfzkoxugjn_o.jpg?...","type":"string"},"os":{"description":"The version of the operating system that captured this Truepic","example":"11.4.1","type":"string"},"pending_upload":true,"photo_list_id":{"description":"The photo list id this Truepic is a part of","example":5678,"type":"number"},"pop_status":{"$ref":"#/components/schemas/TestResult","description":"The status of a picture-of-paper test on this Truepic.","example":"P"},"processing_completed_at":{"description":"The time at which all processing (RIS, Object Detection, Content Analysis, AI Analysis, etc) from Vision and Lens was completed. NULL if incomplete.","example":"2018-08-07 13:16:15","type":"string"},"ris_status":{"$ref":"#/components/schemas/TestResult","description":"The status of a reverse-image-search test on this Truepic.","example":"P"},"sdk_platform":{"description":"The platform on which this Truepic was captured","enum":["ios","Android"],"example":"Android","type":"string"},"sdk_version":{"description":"The version of the SDK on which this Truepic was captured.","example":"2.0.6","type":"string"},"shas256_hash":{"description":"The sha 256 hash of the Truepic signature","example":"900edbargawerfgaeawdefq34fawedfgadfghadfghaerghae5rtb2","type":"string"},"square_image":{"description":"A URL to a thumbnail of the image.","example":"https://d3tbfdtihunht2.cloudfront.net/qfzkoxugjn_s.mp4?...","type":"string"},"state":{"description":"The state where the photo/video was taken, based on GPS coordinates.","example":"CA","type":"string"},"status_overridden":true,"ts":{"description":"The timestamp of the capture of the Truepic","example":"2018-08-07 13:16:15","type":"string"},"type":{"description":"The type of capture","enum":["image","video"],"example":"image","type":"string"},"tz":{"description":"The timezone where the Truepic was taken","example":"America/Phoenix","type":"string"},"updated_at":{"description":"The date/time the resource was last updated","example":"2020-05-01T21:44:40.000Z","format":"date-time","type":"string"},"username":{"description":"The username of the capturer of the Truepic","example":"Apple","type":"string"},"verification_code":{"description":"The unique alphanumeric identifier of the photo/video.","type":"string"},"web_image":{"description":"A URL to a web-optimized version of the image.","example":"https://d3tbfdtihunht2.cloudfront.net/qfzkoxugjn_w.jpg?...","type":"string"}},"required":["ai_analysis_status","archived","blockchain_status","capture_integrity_status","container_id","content_analysis_status","created_at","datetime_status","device_integrity_status","device_time","geolocation_status","id","inspection_id","is_deleted","is_rooted","lat","lens_transfer_done","lng","local_ts","object_detection_status","pending_upload","pop_status","ris_status","status_overridden","ts","tz","updated_at","username","verification_code"],"type":"object"},"UniqueID2":{"additionalProperties":false,"properties":{"custom_field_option_set_id":{"description":"The id of the custom field option set used by this custom field when the entry method is ENTRY_METHOD_SELECTABLE","type":"number"},"entry_method":{"$ref":"#/components/schemas/CustomFieldEntryMethods","description":"The entry method for the custom field"},"is_enabled":{"description":"When true, the user must supply a value for this custom field in order to create an inspection","example":true,"type":"boolean"},"is_required":true,"label":{"description":"The label for the custom field","type":"string"}},"required":["entry_method","is_enabled","is_required"],"type":"object"},"UnsubscribedEmail":{"additionalProperties":false,"description":"An entry marking an email address that has unsubscribed from emails from a specific organization.","properties":{"created_at":{"description":"The date/time the resource was created","example":"2020-05-01T21:44:40.000Z","format":"date-time","type":"string"},"email_address":{"description":"The email address that has unsubscribed.","example":"bob@aol.com","format":"email","type":"string"},"id":{"description":"The id of the resource.","example":1843,"type":"number"},"organization_id":{"description":"The id of the organization that this email has unsubscribed from.","example":532,"type":"number"},"updated_at":{"description":"The date/time the resource was last updated","example":"2020-05-01T21:44:40.000Z","format":"date-time","type":"string"}},"required":["created_at","email_address","id","organization_id","updated_at"],"type":"object"},"UpdateInspectionBody":{"additionalProperties":false,"description":"The request body for PUT /inspections/{inspectionId}","properties":{"assigned_to_member_user_id":{"description":"The id of the user this inspection is assigned to.","example":19,"type":"number"},"custom_field_values":{"description":"The values for the custom fields defined in the inspection type. The order of the values must match the order of the custom fields defined in the inspection type.  If the value is optional then you can provide null for that value.","example":["abc123","def123"],"items":{"type":"string"},"type":"array"},"customer_address":{"description":"The address where the inspection will be performed.","type":"string"},"customer_address_lat":{"description":"The latitude of the address where the inspection will be performed.","type":"string"},"customer_address_lng":{"description":"The longitude of the address where the inspection will be performed.","type":"string"},"customer_email_address":{"description":"The email address of the customer completing the inspection. Required if `send_methods.email` is `true`.","example":"kylorenxninja@gmail.com","format":"email","maxLength":255,"type":"string"},"customer_first_name":{"description":"The first name of the customer completing the inspection.","example":"Kylo","maxLength":255,"type":"string"},"customer_last_name":{"description":"The last name of the customer completing the inspection.","example":"Ren","maxLength":255,"type":"string"},"customer_name":{"description":"The full name of the customer who will be completing the inspection. If specified, then `customer_first_name` and `customer_last_name` will not be provided.","example":"Kylo Ren","maxLength":255,"type":"string"},"customer_phone_country":{"description":"The country code for the customer's phone number.","example":"US","maxLength":2,"type":"string"},"customer_phone_number":{"description":"The mobile number of the customer completing the inspection. Required if `send_methods.text` is `true`.","example":"3028675309","format":"phone","pattern":"/^[\\d]{10}$/","type":"string"},"include_list":true,"inspection_ready_criteria_text":{"description":"Free-form inspection-ready criteria text. Max length 10KB.","example":"Capture all rooms and appliances.","maxLength":10240,"type":"string","nullable":true},"inspection_status_id":{"$ref":"#/components/schemas/InspectionStatusId","description":"The id of the inspection status this inspection is in.","example":4},"list":{"additionalProperties":false,"description":"Optionally include list updates with items. When provided with `include_list: true`, the list will be created or updated for the inspection (if scheduled).","properties":{"groups":{"$ref":"#/components/schemas/ListItemGroups","description":"The groups of items in the list","example":{"grp1":{"name":"Group 2"}}},"items":{"description":"The list items describe prompts to the user for specific photos, videos, or questions during the inspection.","items":{"$ref":"#/components/schemas/ListItemPayload"},"type":"array"}},"required":["items"],"type":"object"},"message_supplement":{"description":"The message supplement (custom note) to be attached to the request text/email. Maximum length of 255 characters.","example":"Please complete in a timely manner","maxLength":255,"type":"string"},"outcome_id":{"description":"The id of the outcome of this inspection.","example":29,"type":"number"},"outcome_reason":{"description":"The reason for the outcome of this inspection","example":"Customer cancelled their service with our company","type":"string"},"scheduled_for":{"description":"The date/time (in UTC) the inspection is scheduled to be sent to the customer","example":"2020-05-01T21:44:40.000Z","format":"date-time","type":"string"},"scheduled_tz":{"description":"The IANA timezone name for the inspection's scheduled datetime. Used only for display purposes, as `scheduled_for` is in UTC.","example":"America/New_York","type":"string"},"send_methods":{"additionalProperties":false,"description":"The method(s) to send the inspection request to the customer completing the inspection.","properties":{"email":{"description":"When true, will send text messages to the customer_email_address","example":false,"type":"boolean"},"text":{"description":"When true, will send text messages to the customer_phone_number","example":true,"type":"boolean"}},"required":["text","email"],"type":"object"}},"required":["organization_address","organization_address_lat","organization_address_lng"],"type":"object"},"UpdateInspectionResult":{"additionalProperties":false,"description":"The response body for PUT /inspections/{inspectionId}","properties":{"api_version":{"description":"The current version number of the Vision API","example":"3.0.0","type":"string"},"message":{"description":"The human readable-status of the response","example":"Success","type":"string"},"response_code":{"description":"The HTTP status code of the response","example":200,"type":"integer"},"result":{"additionalProperties":false,"properties":{"id":{"description":"The id of the inspection request","example":1843,"type":"number"}},"required":["id"],"type":"object"}},"required":["api_version","message","response_code","result"],"type":"object"},"UpdateInternalNoteBody":{"$ref":"#/components/schemas/CreateInternalNoteBody"},"UpdateLandingPageBody":{"additionalProperties":false,"properties":{"inspection_type_ids":{"description":"The IDs of the inspection types that can be created from the landing page.","example":[123,456],"items":{"type":"number"},"type":"array"},"name":{"description":"The name of the landing page.","example":"Landing Page","type":"string"},"page_body":{"description":"The body of the landing page.","example":"Fill out the form below to get started...","type":"string"},"page_title":{"description":"The title of the landing page.","example":"Start your application today!","type":"string"},"team_id":{"description":"The ID of the team that the landing page belongs to.","example":789,"type":"number"}},"type":"object"},"UpdateOrganizationEnabledFeaturesRequestBody":{"description":"Request body for PUT /organizations/enabled-features","items":{"additionalProperties":false,"properties":{"enabled":{"description":"Whether the feature is being enabled / access requested or disabled for the organization","example":true,"type":"boolean"},"type":{"$ref":"#/components/schemas/OrganizationEnabledFeatureType","description":"The type of feature the organization is enabling or disabling","example":"ask_for_app_review"}},"required":["type","enabled"],"type":"object"},"type":"array"},"UpdateOrganizationEnabledFeaturesResponse":{"additionalProperties":false,"description":"Response body for PUT /organization-enabled-features","properties":{"api_version":{"description":"The current version number of the Vision API","example":"3.0.0","type":"string"},"data":{"items":{"$ref":"#/components/schemas/OrganizationEnabledFeature"},"type":"array"},"message":{"description":"The human readable-status of the response","example":"Success","type":"string"},"response_code":{"description":"The HTTP status code of the response","example":200,"type":"integer"}},"required":["api_version","data","message","response_code"],"type":"object"},"UpdateTeamRequestBody":{"additionalProperties":false,"description":"The request body for the PUT /teams/{teamId} endpoint","properties":{"allow_image_deletes":{"default":true,"description":"Whether to allow app users to delete images during an inspection.","example":true,"type":"boolean"},"allow_list_item_capture_max":{"default":false,"description":"Whether app users should have a maximum limit of captures per list item.","example":true,"type":"boolean"},"app_success_message":{"description":"The message displayed to the customer on completion of the inspection.","type":"string"},"auto_finish_reminder_duration":{"description":"The amount of time until an auto-reminder is sent for incomplete inspections that have some photos/videos/question answers. `null` means auto-reminders are disabled. Any format supported by https://github.com/vercel/ms is valid.  Multiple reminders can be specified by separating them with a comma.","example":"12h,1d","type":"string"},"auto_reminder_duration":{"description":"The amount of time until an auto-reminder is sent for inspections without photos/videos/question answers. `null` means auto-reminders are disabled. Any format supported by https://github.com/vercel/ms is valid.  Multiple durations can be specified by separating them with a comma.","example":"12h,1d","type":"string"},"color_primary":{"description":"The primary hex color code used for branding in the app.","example":"#0F7EC1","type":"string"},"customer_app_label":{"description":"The company name to display in the app.","example":"Quality Capital","type":"string"},"customer_item_label":{"description":"The word for an \"item\" in the context of the team.","example":"jewelry","type":"string"},"customer_support_number":{"description":"The phone number attached to text messages for app users to contact for customer support.","example":"1 (516) 271-1526","format":"phone","type":"string"},"distance_from_customer_address_threshold":{"description":"The distance (in meters) from the customer's address a photo/video can be taken before being flagged. `null` can be set to disable the flag.","example":1500,"type":"number"},"jwt_customer_expiry":{"default":"480h","description":"The amount of time before an inspection request token expires. Any format supported by https://github.com/vercel/ms is valid.","example":"120h","type":"string"},"name":{"description":"The name of the team.","example":"Claims","type":"string"},"phone_numbers":{"description":"Array of phone numbers to update for the team","items":{"additionalProperties":false,"properties":{"country":{"description":"The country code for this phone number.","example":"US","type":"string"},"id":{"description":"The id of the team phone number record","example":1843,"type":"number"},"phone_number":{"description":"The phone number used to send text messages for inspection requests.","example":"15162711526","format":"phone","type":"string"}},"required":["id","country","phone_number"],"type":"object"},"type":"array"}},"required":["jwt_organization_expiry"],"type":"object"},"UpdateTeamResult":{"additionalProperties":false,"description":"The response body for the PUT /teams/{teamId} endpoint","properties":{"api_version":{"description":"The current version number of the Vision API","example":"3.0.0","type":"string"},"message":{"description":"The human readable-status of the response","example":"Success","type":"string"},"response_code":{"description":"The HTTP status code of the response","example":200,"type":"integer"},"result":{"items":{"type":"number"},"type":"array"}},"required":["api_version","message","response_code","result"],"type":"object"},"UpdateUserBody":{"additionalProperties":false,"description":"The request body for PUT /users/{userId}","properties":{"email":{"description":"The email address of the user.","example":"kylorenxninja@potato.com","format":"email","type":"string"},"first_name":{"description":"The first name of the user.","example":"Kylo","type":"string"},"last_name":{"description":"The last name of the user.","example":"Ren","type":"string"},"role":{"$ref":"#/components/schemas/UserCreateRole","description":"A role to assign to the user. This will dictate what permissions the user has in the Vision system."},"teams":{"description":"A list of team IDs. This will update the teams that the user is assigned to.","items":{"type":"number"},"type":"array"}},"type":"object"},"UpdateUserResult":{"$ref":"#/components/schemas/CreateUserResult","description":"The response body for PUT /users/{userId}"},"UpdateWebsiteFormBody":{"additionalProperties":false,"properties":{"allowed_origins":{"description":"The domains that the website form is allowed to be embedded on. URLs must include `https://` and cannot include a path. An asterisk (*) can be used in place of the subdomain to allow any subdomain.","example":["https://website1.com","https://subdomain.website1.com","https://*.website2.com"],"items":{"type":"string"},"type":"array"},"inspection_type_ids":{"description":"The IDs of the inspection types that can be created from the website form.","example":[123,456],"items":{"type":"number"},"type":"array"},"is_email_required":{"description":"Whether the email field is required on the website form. Defaults to `false`.","example":false,"type":"boolean"},"is_phone_required":{"description":"Whether the phone field is required on the website form. Defaults to `false`.","example":false,"type":"boolean"},"name":{"description":"The name of the website form.","example":"Landing Page","type":"string"},"should_show_address":{"description":"Whether the address field should be shown on the website form when it is optional. The field is always shown if it is required by the inspection type. Defaults to `false`.","example":false,"type":"boolean"},"team_id":{"description":"The ID of the team that the website form creates inspections within.","example":789,"type":"number"}},"type":"object"},"User":{"additionalProperties":false,"description":"A user of Vision. This could be a Vision website user or mobile app user.","properties":{"auth_id":{"description":"The auth identifier of the user.","example":"wawqZ8nABRWEpxjZKegwe@clients","type":"string"},"created_at":{"description":"The date/time the resource was created","example":"2020-05-01T21:44:40.000Z","format":"date-time","type":"string"},"email":{"description":"The email address of the user.","example":"kylorenxninja@potato.com","format":"email","type":"string"},"first_name":{"description":"The first name of the user.","example":"Kylo","type":"string"},"id":{"description":"The id of the user","example":1843,"type":"number"},"inspection_id":{"description":"The id of the inspection this user belongs to. Indicates this is a mobile app user performing an inspection. References `inspections.id`","example":2412,"type":"number"},"last_name":{"description":"The last name of the user.","example":"Ren","type":"string"},"last_session_start":{"description":"The date/time the user last logged in","example":"2020-05-01T21:44:40.000Z","format":"date-time","type":"string"},"organization_id":{"description":"The id of the organization this user belongs to.","example":117,"type":"number"},"phone_number":{"description":"The phone number of the user.","example":"5558675309","format":"phone","type":"string"},"search":{"description":"Search terminology for indexing the user","example":"'member':2 'bob':1 'bob@aol.com':3","type":"string"},"team_id":{"description":"The id of the team this user belongs to.","example":521,"type":"number"},"updated_at":{"description":"The date/time the resource was last updated","example":"2020-05-01T21:44:40.000Z","format":"date-time","type":"string"}},"required":["created_at","id","updated_at"],"type":"object"},"UserCreateRole":{"description":"The roles that can be assigned to a user in a POST /users request","enum":["VISION_AGENT_ADMIN","VISION_AGENT_REPORT","VISION_AGENT","VISION_AGENT_OWN_INSPECTIONS","VIEW_ONLY"],"type":"string"},"VerificationResult":{"description":"The possible verification results for an inspection. Acts as a collation of all photos/videos in an inspection","enum":["pass","fail","warn"],"type":"string"},"VisionAPIVersion":{"enum":["v2","v3"],"type":"string"},"VisionRole":{"description":"The possible roles in the Vision system","enum":["SUPER_ADMIN","VISION_AGENT_ADMIN","VISION_AGENT","VISION_CONSUMER","AUTH0_BOT","WEBSITE_FORM_BOT","GROUP_AGENT","VISION_AGENT_OWN_INSPECTIONS","VIEW_ONLY","VISION_AGENT_REPORT"],"type":"string"},"WebsiteFormInspectionSerialized":{"additionalProperties":false,"properties":{"can_email":{"type":"boolean"},"can_text":{"type":"boolean"},"link":{"type":"string"},"token":{"type":"string"},"token_expires_at":{"type":"number"}},"required":["link","can_email","can_text","token","token_expires_at"],"type":"object"},"WebsiteFormSerialized":{"additionalProperties":false,"properties":{"allowed_origins":{"description":"The domains that the website form is allowed to be embedded on. URLs must include `https://` and cannot include a path. An asterisk (*) can be used in place of the subdomain to allow any subdomain.","example":["https://website1.com","https://subdomain.website1.com","https://*.website2.com"],"items":{"type":"string"},"type":"array"},"created_at":{"description":"The date/time the resource was created","example":"2020-05-01T21:44:40.000Z","format":"date-time","type":"string"},"id":{"description":"The ID of the website form.","example":123,"type":"number"},"is_email_required":{"description":"Whether the email field is required on the website form. Defaults to `false`.","example":false,"type":"boolean"},"is_phone_required":{"description":"Whether the phone field is required on the website form. Defaults to `false`.","example":false,"type":"boolean"},"name":{"description":"The name of the website form.","example":"Landing Page","type":"string"},"should_show_address":{"description":"Whether the address field should be shown on the website form when it is optional. The field is always shown if it is required by the inspection type. Defaults to `false`.","example":false,"type":"boolean"},"team_id":{"description":"The ID of the team that the website form creates inspections within.","example":789,"type":"number"},"token":{"description":"The unique token used by the website form to authenticate with the API.","example":"-SQuSE62r4ISFCE4EOOTtu3yx1SW8i6PE7VMZwvVZ8TNyliC","type":"string"},"updated_at":{"description":"The date/time the resource was last updated","example":"2020-05-01T21:44:40.000Z","format":"date-time","type":"string"}},"required":["id","name","token","team_id","allowed_origins","should_show_address","is_email_required","is_phone_required","created_at","updated_at"],"type":"object"},"WebsiteFormSerializedWithInspectionTypeIds":{"additionalProperties":false,"properties":{"allowed_origins":{"description":"The domains that the website form is allowed to be embedded on. URLs must include `https://` and cannot include a path. An asterisk (*) can be used in place of the subdomain to allow any subdomain.","example":["https://website1.com","https://subdomain.website1.com","https://*.website2.com"],"items":{"type":"string"},"type":"array"},"created_at":{"description":"The date/time the resource was created","example":"2020-05-01T21:44:40.000Z","format":"date-time","type":"string"},"id":{"description":"The ID of the website form.","example":123,"type":"number"},"inspection_type_ids":{"description":"The IDs of the inspection types that can be created from the website form.","example":[123,456],"items":{"type":"number"},"type":"array"},"is_email_required":{"description":"Whether the email field is required on the website form. Defaults to `false`.","example":false,"type":"boolean"},"is_phone_required":{"description":"Whether the phone field is required on the website form. Defaults to `false`.","example":false,"type":"boolean"},"name":{"description":"The name of the website form.","example":"Landing Page","type":"string"},"should_show_address":{"description":"Whether the address field should be shown on the website form when it is optional. The field is always shown if it is required by the inspection type. Defaults to `false`.","example":false,"type":"boolean"},"team_id":{"description":"The ID of the team that the website form creates inspections within.","example":789,"type":"number"},"token":{"description":"The unique token used by the website form to authenticate with the API.","example":"-SQuSE62r4ISFCE4EOOTtu3yx1SW8i6PE7VMZwvVZ8TNyliC","type":"string"},"updated_at":{"description":"The date/time the resource was last updated","example":"2020-05-01T21:44:40.000Z","format":"date-time","type":"string"}},"required":["allowed_origins","created_at","id","inspection_type_ids","is_email_required","is_phone_required","name","should_show_address","team_id","token","updated_at"],"type":"object"}},"securitySchemes":{"AccessToken":{"type":"http","description":"Authorization is done via OAuth 2's [client credentials flow](https://auth0.com/docs/flows/concepts/client-credentials).\n\nIn short, using the `client_id` and `client_secret` we issue you, you request an access token from our authorization service. You then include this access token in subsequent API requests in the `Authorization: Bearer {access_token}` header.\n\nEach access token is valid for 72 hours, and should be stored on your end so that it can be used for all API requests in that time frame. The time of expiration is included in both the authorization service response (`expires_in`) and decoded JWT access token (`exp`). There's no need to generate a new access token for every API request. When the access token has expired (or is close to expiring), simply make another request to our authorization service for a new one.\n\nAn access token can be generated by making a `POST` request to our authorization service's [token endpoint](https://auth0.com/docs/api/authentication?http#client-credentials-flow):\n\n```\nhttps://vision-auth.truepic.com/oauth/token\n```\n\nInclude the following `application/x-www-form-urlencoded` payload:\n\n```\n{\n  audience: 'https://vision-api.truepic.com',\n  grant_type: 'client_credentials',\n  client_id: '{CLIENT_ID}',\n  client_secret: '{CLIENT_SECRET}'\n}\n```","scheme":"bearer","bearerFormat":"JWT"},"OAuth2ClientCredentials":{"type":"oauth2","description":"See `AccessToken` above.","flows":{"clientCredentials":{"tokenUrl":"https://vision-auth.truepic.com/oauth/token","scopes":{}}}}}},"paths":{"/inspections":{"get":{"tags":["Inspections"],"summary":"Get a list of inspection requests","responses":{"200":{"description":"The request for a list of inspection requests was successful.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/GetInspectionsResult"}}}},"400":{"$ref":"#/components/responses/ErrorBadRequest"},"401":{"$ref":"#/components/responses/ErrorUnauthorized"},"403":{"$ref":"#/components/responses/ErrorForbidden"},"404":{"$ref":"#/components/responses/ErrorNotFound"},"412":{"$ref":"#/components/responses/ErrorPreconditionFailed"},"500":{"$ref":"#/components/responses/ErrorUnhandled"}},"parameters":[{"name":"team_id","in":"query","description":"The ID of the team to return inspection requests created under.\n\nIf not set, inspection requests from all teams are returned.\n","schema":{"type":"integer","example":123}},{"name":"filter","in":"query","explode":true,"style":"deepObject","description":"Filters to limit the results returned.","schema":{"type":"object","properties":{"team_id":{"type":"object","description":"Filter by the ID of the team.","properties":{"in":{"type":"array","items":{"type":"integer"},"example":[123,456]}}},"status":{"type":"object","description":"Filter by the ID of the status.","properties":{"=":{"type":"integer","example":3},"in":{"type":"array","items":{"type":"integer"},"example":[1,2]}}},"member":{"type":"object","description":"Filter by the ID of the member who created the inspection request. Same as `created_by_member`.","properties":{"in":{"type":"array","items":{"type":"integer"},"example":[123,456]}}},"created_by_member":{"type":"object","description":"Filter by the ID of the member who created the inspection request. Same as `member`.","properties":{"in":{"type":"array","items":{"type":"integer"},"example":[123,456]}}},"assigned_to_member":{"type":"object","description":"Filter by the ID of the member who is currently assigned to the inspection request.","properties":{"in":{"type":"array","items":{"type":"integer"},"example":[123,456]}}},"unique_id":{"type":"object","description":"Filter by the identifier that you use to reference the customer in your system.","properties":{"=":{"type":"string","example":"abc123"}}},"unique_id_two":{"type":"object","description":"Filter by the second identifier that you use to reference the customer in your system.","properties":{"=":{"type":"string","example":"def456"}}},"custom_field_1":{"type":"object","description":"Filter by first custom field specified on the inspection type.","properties":{"=":{"type":"string","example":"abc123"}}},"custom_field_2":{"type":"object","description":"Filter by the second custom field specified on the inspection type.","properties":{"=":{"type":"string","example":"def456"}}},"photos":{"type":"object","description":"Filter by whether the inspection request has photos/videos or not.","properties":{"is":{"nullable":true,"example":null},"is not":{"nullable":true,"example":null}}},"verification":{"type":"object","description":"Filter by the aggregate verification result of all photos/videos.","properties":{"in":{"type":"array","items":{"type":"string","enum":["pass","fail","warn"]},"example":"pass"}}},"group_id":{"type":"object","description":"Filter by the ID of the group that self-initiated the inspection request.","properties":{"in":{"type":"array","items":{"type":"integer"},"example":[123,456]}}},"inspection_type":{"type":"object","description":"Filter by the ID of the inspection type.","properties":{"in":{"type":"array","items":{"type":"integer"},"example":[123,456]}}},"outcome":{"type":"object","description":"Filter by the ID of an outcome.","properties":{"in":{"type":"array","items":{"type":"integer"},"example":[123,456]}}},"created_at":{"type":"object","description":"Filter by the date/time when the inspection request was created.","properties":{">":{"type":"string","format":"date-time","example":"2020-05-01T21:44:40.000Z"},">=":{"type":"string","format":"date-time","example":"2020-05-01T21:44:40.000Z"},"<":{"type":"string","format":"date-time","example":"2020-05-01T21:44:40.000Z"},"<=":{"type":"string","format":"date-time","example":"2020-05-01T21:44:40.000Z"}}},"scheduled_for":{"type":"object","description":"Filter by the date/time when the inspection is scheduled for.","properties":{">":{"type":"string","format":"date-time","example":"2020-05-01T21:44:40.000Z"},">=":{"type":"string","format":"date-time","example":"2020-05-01T21:44:40.000Z"},"<":{"type":"string","format":"date-time","example":"2020-05-01T21:44:40.000Z"},"<=":{"type":"string","format":"date-time","example":"2020-05-01T21:44:40.000Z"}}}}}},{"$ref":"","name":"sort","in":"query","style":"deepObject","explode":true,"description":"Sorting to order the results returned.\n\nThe order of properties is important, as sorting is applied in the order specified.\n\nDefaults to `created_at` `asc`.\n","schema":{"type":"object","properties":{"status":{"type":"string","description":"Sort by the name of the status.","enum":["asc","desc"],"example":"asc"},"inspection_type":{"type":"string","description":"Sort by the name of the inspection type.","enum":["asc","desc"],"example":"asc"},"member":{"type":"string","description":"Sort by the last name of the member who created the inspection request. Same as `created_by_member`.","enum":["asc","desc"],"example":"asc"},"created_by_member":{"type":"string","description":"Sort by the last name of the member who created the inspection request. Same as `member`.","enum":["asc","desc"],"example":"asc"},"assigned_to_member":{"type":"string","description":"Sort by the last name of the member who is currently assigned to the inspection request.","enum":["asc","desc"],"example":"asc"},"photos":{"type":"string","description":"Sort by the date/time when the last photo/video was uploaded.","enum":["asc","desc"],"example":"asc"},"verification":{"type":"string","description":"Sort by the aggregate verification result of all photos/videos.","enum":["asc","desc"],"example":"asc"},"created_at":{"type":"string","description":"Sort by the date/time when the inspection request was created.","enum":["asc","desc"],"example":"asc"},"scheduled_for":{"type":"string","description":"Sort by the date/time when the inspection request was scheduled.","enum":["asc","desc"],"example":"asc"}}}},{"$ref":"#/components/parameters/page"}]},"post":{"tags":["Inspections"],"summary":"Create an inspection","responses":{"200":{"description":"Request Successful","content":{"application/json":{"schema":{"$ref":"#/components/schemas/CreateInspectionResult"}}}},"400":{"$ref":"#/components/responses/ErrorBadRequest"},"401":{"$ref":"#/components/responses/ErrorUnauthorized"},"403":{"$ref":"#/components/responses/ErrorForbidden"},"404":{"$ref":"#/components/responses/ErrorNotFound"},"412":{"$ref":"#/components/responses/ErrorPreconditionFailed"},"500":{"$ref":"#/components/responses/ErrorUnhandled"}},"parameters":[{"name":"include","in":"query","description":"The top-level `result` fields to include in the response.\n\nIf not set, all fields are included by default. If set, `id`, `created_at`, and `updated_at` are always included as a baseline.\n","schema":{"type":"array","items":{"type":"string"},"example":["customer_first_name","customer_last_name","organization_team","inspection_type"]}}],"requestBody":{"required":true,"content":{"application/json":{"schema":{"$ref":"#/components/schemas/CreateInspectionBody"}}}}}},"/inspections/{excludeText}":{"post":{"tags":["Inspections"],"summary":"Create an inspection","responses":{"200":{"description":"Request Successful","content":{"application/json":{"schema":{"$ref":"#/components/schemas/CreateInspectionResult"}}}},"400":{"$ref":"#/components/responses/ErrorBadRequest"},"401":{"$ref":"#/components/responses/ErrorUnauthorized"},"403":{"$ref":"#/components/responses/ErrorForbidden"},"404":{"$ref":"#/components/responses/ErrorNotFound"},"412":{"$ref":"#/components/responses/ErrorPreconditionFailed"},"500":{"$ref":"#/components/responses/ErrorUnhandled"}},"parameters":[{"name":"include","in":"query","description":"The top-level `result` fields to include in the response.\n\nIf not set, all fields are included by default. If set, `id`, `created_at`, and `updated_at` are always included as a baseline.\n","schema":{"type":"array","items":{"type":"string"},"example":["customer_first_name","customer_last_name","organization_team","inspection_type"]}},{"name":"excludeText","in":"path","description":"When provided, the inspection will be sent but the user will not be notified via text message.","schema":{"type":"string"},"required":true,"example":"exclude-text"}],"requestBody":{"required":true,"content":{"application/json":{"schema":{"$ref":"#/components/schemas/CreateInspectionBody"}}}}}},"/inspections/{inspectionId}/complete":{"post":{"tags":["Inspections"],"summary":"Complete an inspection","description":"Finish an inspection request and set it to Ready for Review. The inspection request must be In Progress, otherwise a `400` error will be returned.","responses":{"200":{"description":"The inspection request was successfully finished and set to Ready for Review.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ResponseData"}}}},"400":{"$ref":"#/components/responses/ErrorBadRequest"},"401":{"$ref":"#/components/responses/ErrorUnauthorized"},"403":{"$ref":"#/components/responses/ErrorForbidden"},"404":{"$ref":"#/components/responses/ErrorNotFound"},"412":{"$ref":"#/components/responses/ErrorPreconditionFailed"},"500":{"$ref":"#/components/responses/ErrorUnhandled"}},"parameters":[{"$ref":"#/components/parameters/inspectionId"}]}},"/inspections/{inspectionId}":{"get":{"tags":["Inspections"],"summary":"Get an inspection","responses":{"200":{"description":"The request was successful.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/GetInspectionResult"}}}},"400":{"$ref":"#/components/responses/ErrorBadRequest"},"401":{"$ref":"#/components/responses/ErrorUnauthorized"},"403":{"$ref":"#/components/responses/ErrorForbidden"},"404":{"$ref":"#/components/responses/ErrorNotFound"},"412":{"$ref":"#/components/responses/ErrorPreconditionFailed"},"500":{"$ref":"#/components/responses/ErrorUnhandled"}},"parameters":[{"$ref":"#/components/parameters/inspectionId"},{"name":"include","in":"query","description":"The top-level `result` fields to include in the response.\n\nIf not set, all fields are included by default. If set, `id`, `created_at`, and `updated_at` are always included as a baseline.\n","schema":{"type":"array","items":{"type":"string"},"example":["customer_first_name","customer_last_name","organization_team","inspection_type"]}}]},"put":{"tags":["Inspections"],"summary":"Update an inspection","requestBody":{"required":true,"content":{"application/json":{"schema":{"$ref":"#/components/schemas/UpdateInspectionBody"}}}},"responses":{"200":{"description":"The request was successful.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/UpdateInspectionResult"}}}},"400":{"$ref":"#/components/responses/ErrorBadRequest"},"401":{"$ref":"#/components/responses/ErrorUnauthorized"},"403":{"$ref":"#/components/responses/ErrorForbidden"},"404":{"$ref":"#/components/responses/ErrorNotFound"},"412":{"$ref":"#/components/responses/ErrorPreconditionFailed"},"500":{"$ref":"#/components/responses/ErrorUnhandled"}},"parameters":[{"$ref":"#/components/parameters/inspectionId"}]}},"/inspections/{inspectionId}/export":{"get":{"tags":["Inspections"],"description":"Exactly the same as the matching `POST` endpoint, but is limited in the amount of data that can be passed in the query string due to the maximum URL length allowed by browsers. Use the `POST` endpoint to send larger payloads.","summary":"Export a PDF of an inspection","parameters":[{"$ref":"#/components/parameters/inspectionId"},{"name":"async","in":"query","description":"Whether to perform synchronously (in the request/response cycle) or queue for asynchronous export.\n\nIf `0` (or unspecified), the PDF is exported synchronously and returned in the response. This is the default for backwards-compatibility, but is deprecated in favor of performing asynchronously.\n\nIf `1`, the PDF is queued for asynchronous export and an `Operation` is returned to track its progress. This is recommended.\n","schema":{"type":"boolean"}},{"name":"filter","in":"query","style":"deepObject","explode":true,"description":"Filters which photos/videos are included in the PDF. By default all photos/videos are included and this property is not required.","schema":{"type":"object","required":["photos"],"properties":{"photos":{"type":"array","description":"Limit the PDF to a subset of photos/videos.","items":{"type":"integer","description":"The ID of a photo/video to include in the PDF."}}}}},{"name":"include[]","in":"query","description":"Additional sections to include that are NOT included by default. If you do not want to include any extra sections, you can omit this property.","schema":{"type":"array","items":{"type":"string","enum":["inspectionNote"]}}},{"name":"exclude[]","in":"query","description":"Specific sections to exclude that are included by default. If you do not want to exclude any sections, you can omit this property.","schema":{"type":"array","items":{"type":"string","enum":["questions","thumbnails","imageDetails","timeline"]}}},{"name":"tz","in":"query","description":"The IANA time zone name to use when displaying dates/times in the PDF. Defaults to UTC.","schema":{"type":"string","example":"America/New_York"}}],"responses":{"200":{"description":"The PDF was successfully exported synchronously.","content":{"application/pdf":{"schema":{"type":"string","format":"binary"}}}},"202":{"description":"The PDF was successfully queued for asynchronous export.","content":{"application/json":{"schema":{"allOf":[{"$ref":"#/components/schemas/ResponseData"},{"type":"object","required":["result"],"properties":{"result":{"$ref":"#/components/schemas/Operation"}}}]}}}},"400":{"$ref":"#/components/responses/ErrorBadRequest"},"401":{"$ref":"#/components/responses/ErrorUnauthorized"},"403":{"$ref":"#/components/responses/ErrorForbidden"},"404":{"$ref":"#/components/responses/ErrorNotFound"},"412":{"$ref":"#/components/responses/ErrorPreconditionFailed"},"500":{"$ref":"#/components/responses/ErrorUnhandled"}}},"post":{"tags":["Inspections"],"description":"Exactly the same as the matching `GET` endpoint, but allows for a larger payload, as it's sent in the body instead of the query string.","summary":"Export a PDF of an inspection","parameters":[{"$ref":"#/components/parameters/inspectionId"}],"responses":{"200":{"description":"The PDF was successfully exported synchronously.","content":{"application/pdf":{"schema":{"type":"string","format":"binary"}}}},"202":{"description":"The PDF was successfully queued for asynchronous export.","content":{"application/json":{"schema":{"allOf":[{"$ref":"#/components/schemas/ResponseData"},{"type":"object","required":["result"],"properties":{"result":{"$ref":"#/components/schemas/Operation"}}}]}}}},"400":{"$ref":"#/components/responses/ErrorBadRequest"},"401":{"$ref":"#/components/responses/ErrorUnauthorized"},"403":{"$ref":"#/components/responses/ErrorForbidden"},"404":{"$ref":"#/components/responses/ErrorNotFound"},"412":{"$ref":"#/components/responses/ErrorPreconditionFailed"},"500":{"$ref":"#/components/responses/ErrorUnhandled"}},"requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ExportInspectionPDFBody"}}}}}},"/inspections/{inspectionId}/inspection-type":{"put":{"tags":["Inspections"],"summary":"Update the type of an existing inspection","description":"Updates the type of an existing inspection. The inspection type can only be changed to a inspection type that is assigned to the inspection's team. Changing the type of an inspection will delete any already-uploaded Truepics and will automatically re-send the request email/text to the customer. This endpoint will also set the inspection status to `Created`. Closed or Canceled inspections cannot have their inspection type changed.","requestBody":{"required":true,"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ChangeInspectionTypeBody"}}}},"responses":{"200":{"description":"The request was successful.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ResponseData"}}}},"400":{"$ref":"#/components/responses/ErrorBadRequest"},"401":{"$ref":"#/components/responses/ErrorUnauthorized"},"403":{"$ref":"#/components/responses/ErrorForbidden"},"404":{"$ref":"#/components/responses/ErrorNotFound"},"412":{"$ref":"#/components/responses/ErrorPreconditionFailed"},"500":{"$ref":"#/components/responses/ErrorUnhandled"}},"parameters":[{"$ref":"#/components/parameters/inspectionId"}]}},"/inspections/{inspectionId}/flag-device":{"post":{"tags":["Inspections"],"summary":"Set flags on a device for an inspection","requestBody":{"required":true,"content":{"application/json":{"schema":{"$ref":"#/components/schemas/FlagDeviceRequestBody"}}}},"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ResponseData"}}}},"400":{"$ref":"#/components/responses/ErrorBadRequest"},"401":{"$ref":"#/components/responses/ErrorUnauthorized"},"403":{"$ref":"#/components/responses/ErrorForbidden"},"404":{"$ref":"#/components/responses/ErrorNotFound"},"412":{"$ref":"#/components/responses/ErrorPreconditionFailed"},"500":{"$ref":"#/components/responses/ErrorUnhandled"}},"parameters":[{"$ref":"#/components/parameters/inspectionId"}]}},"/users":{"get":{"tags":["Users"],"summary":"Get a list of users","responses":{"200":{"description":"The request for a list of active users was successful.","content":{"application/json":{"schema":{"allOf":[{"$ref":"#/components/schemas/GetUsersResult"}]}}}},"400":{"$ref":"#/components/responses/ErrorBadRequest"},"401":{"$ref":"#/components/responses/ErrorUnauthorized"},"403":{"$ref":"#/components/responses/ErrorForbidden"},"404":{"$ref":"#/components/responses/ErrorNotFound"},"412":{"$ref":"#/components/responses/ErrorPreconditionFailed"},"500":{"$ref":"#/components/responses/ErrorUnhandled"}},"parameters":[{"name":"filter","in":"query","style":"deepObject","explode":true,"description":"Filters to limit the results returned.","schema":{"type":"object","properties":{"role":{"type":"object","description":"Filter by one or more internal role identifiers","properties":{"in":{"type":"array","items":{"type":"string","enum":["VISION_AGENT_ADMIN","VISION_AGENT_REPORT","VISION_AGENT","VISION_AGENT_OWN_INSPECTIONS","VIEW_ONLY"]},"example":["VISION_AGENT","VIEW_ONLY"]}}},"q":{"type":"object","description":"Full-text search of the user's first name, last name, and email.","properties":{"=":{"type":"string","description":"The search term to use. This can be a partial or full name or email address.","maxLength":100,"example":"alice"}}}}}},{"name":"sort","in":"query","style":"deepObject","explode":true,"description":"Sorting criteria, applied in the order given.\nAllowed fields: first_name, last_name, name, email, role, rank, last_session_start.","schema":{"type":"object","properties":{"first_name":{"type":"string","description":"Sort by first name.","enum":["asc","desc"],"example":"asc"},"last_name":{"type":"string","description":"Sort by last name.","enum":["asc","desc"],"example":"desc"},"name":{"type":"string","description":"Sort by full name, last name first.","enum":["asc","desc"],"example":"asc"},"email":{"type":"string","description":"Sort by email address.","enum":["asc","desc"],"example":"asc"},"role":{"type":"string","description":"Sort by role.","enum":["asc","desc"],"example":"desc"},"rank":{"type":"string","description":"Sort by full-text search rank. This is only used when the `q` filter is applied.","enum":["asc","desc"],"example":"desc"},"last_session_start":{"type":"string","description":"Sort by the last time the user logged in.","enum":["asc","desc"],"example":"desc"}}}},{"$ref":"#/components/parameters/page"}]},"post":{"tags":["Users"],"summary":"Create a user","responses":{"200":{"description":"Request Successful","content":{"application/json":{"schema":{"$ref":"#/components/schemas/CreateUserResult"}}}},"400":{"$ref":"#/components/responses/ErrorBadRequest"},"401":{"$ref":"#/components/responses/ErrorUnauthorized"},"403":{"$ref":"#/components/responses/ErrorForbidden"},"404":{"$ref":"#/components/responses/ErrorNotFound"},"412":{"$ref":"#/components/responses/ErrorPreconditionFailed"},"500":{"$ref":"#/components/responses/ErrorUnhandled"}},"requestBody":{"required":true,"content":{"application/json":{"schema":{"$ref":"#/components/schemas/CreateUserBody"}}}}}},"/users/{userId}":{"get":{"tags":["Users"],"summary":"Get a user","parameters":[{"$ref":"#/components/parameters/userId"}],"responses":{"200":{"description":"Returns the user requested by id","content":{"application/json":{"schema":{"$ref":"#/components/schemas/GetUserResult"}}}},"400":{"$ref":"#/components/responses/ErrorBadRequest"},"401":{"$ref":"#/components/responses/ErrorUnauthorized"},"403":{"$ref":"#/components/responses/ErrorForbidden"},"404":{"$ref":"#/components/responses/ErrorNotFound"},"412":{"$ref":"#/components/responses/ErrorPreconditionFailed"},"500":{"$ref":"#/components/responses/ErrorUnhandled"}}},"put":{"tags":["Users"],"summary":"Update a user","parameters":[{"$ref":"#/components/parameters/userId"}],"requestBody":{"required":true,"content":{"application/json":{"schema":{"$ref":"#/components/schemas/UpdateUserBody"}}}},"responses":{"200":{"description":"Successfully updated the user","content":{"application/json":{"schema":{"allOf":[{"$ref":"#/components/schemas/UpdateUserResult"}]}}}},"400":{"$ref":"#/components/responses/ErrorBadRequest"},"401":{"$ref":"#/components/responses/ErrorUnauthorized"},"403":{"$ref":"#/components/responses/ErrorForbidden"},"404":{"$ref":"#/components/responses/ErrorNotFound"},"412":{"$ref":"#/components/responses/ErrorPreconditionFailed"},"500":{"$ref":"#/components/responses/ErrorUnhandled"}}},"delete":{"tags":["Users"],"summary":"Remove a user","parameters":[{"$ref":"#/components/parameters/userId"}],"responses":{"200":{"description":"User Access Removed","content":{"application/json":{"schema":{"allOf":[{"$ref":"#/components/schemas/RemoveUserResult"},{"type":"object","properties":{"message":{"example":"User access removed"}}}]}}}},"400":{"$ref":"#/components/responses/ErrorBadRequest"},"401":{"$ref":"#/components/responses/ErrorUnauthorized"},"403":{"$ref":"#/components/responses/ErrorForbidden"},"404":{"$ref":"#/components/responses/ErrorNotFound"},"412":{"$ref":"#/components/responses/ErrorPreconditionFailed"},"500":{"$ref":"#/components/responses/ErrorUnhandled"}}}},"/org-asset/{assetType}/upload":{"post":{"tags":["Lists"],"summary":"Upload an example photo","description":"This endpoint will return image URLs for a resized 1000px max width/height version and a 320x320 thumbnail version. These URLs can be used in the payload of the \"PUT/POST /lists/{listID}\" endpoint to attach an example photo to a list item. This endpoint currently only accepts png/jpg files, with a max file size of 100MB. There are no limits on uploaded image dimensions.","parameters":[{"in":"path","name":"assetType","description":"The type of asset being uploaded","schema":{"type":"string","enum":["list-item-example-photo"]},"required":true}],"requestBody":{"required":true,"content":{"multipart/form-data":{"schema":{"type":"object","properties":{"asset":{"type":"string","format":"binary"}}}}}},"responses":{"200":{"description":"Request Successful","content":{"application/json":{"schema":{"$ref":"#/components/schemas/PostOrgAssetResult"}}}},"400":{"$ref":"#/components/responses/ErrorBadRequest"},"401":{"$ref":"#/components/responses/ErrorUnauthorized"},"403":{"$ref":"#/components/responses/ErrorForbidden"},"404":{"$ref":"#/components/responses/ErrorNotFound"},"412":{"$ref":"#/components/responses/ErrorPreconditionFailed"},"500":{"$ref":"#/components/responses/ErrorUnhandled"}}}},"/organization-teams":{"post":{"tags":["Teams"],"summary":"Create a team","requestBody":{"required":true,"content":{"application/json":{"schema":{"$ref":"#/components/schemas/CreateTeamParams"}}}},"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"allOf":[{"$ref":"#/components/schemas/ResponseData"}]}}}},"400":{"$ref":"#/components/responses/ErrorBadRequest"},"401":{"$ref":"#/components/responses/ErrorUnauthorized"},"403":{"$ref":"#/components/responses/ErrorForbidden"},"404":{"$ref":"#/components/responses/ErrorNotFound"},"412":{"$ref":"#/components/responses/ErrorPreconditionFailed"},"500":{"$ref":"#/components/responses/ErrorUnhandled"}}},"get":{"tags":["Teams"],"summary":"Get a list of teams","responses":{"200":{"description":"The request for a list of existing teams was successful.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/GetTeamsResult"}}}},"400":{"$ref":"#/components/responses/ErrorBadRequest"},"401":{"$ref":"#/components/responses/ErrorUnauthorized"},"403":{"$ref":"#/components/responses/ErrorForbidden"},"404":{"$ref":"#/components/responses/ErrorNotFound"},"412":{"$ref":"#/components/responses/ErrorPreconditionFailed"},"500":{"$ref":"#/components/responses/ErrorUnhandled"}},"parameters":[{"name":"sort","in":"query","style":"deepObject","explode":true,"description":"Sorting to order the results returned.\n\nThe order of properties is important, as sorting is applied in the order specified.\n\nDefaults to `name` `asc`.\n","schema":{"type":"object","properties":{"name":{"type":"string","description":"Sort by the name of the team.","enum":["asc","desc"],"example":"asc"},"created_at":{"type":"string","description":"Sort by the date/time when the team was created.","enum":["asc","desc"],"example":"asc"}}}},{"name":"page","in":"query","style":"deepObject","explode":true,"description":"Pagination to limit the number of results returned.\n\nDefaults to the first page of 20 results, with a maximum of 100 results per page.\n","schema":{"type":"object","properties":{"number":{"type":"integer","description":"The page number to return.\n\nDefaults to 1.\n","example":3},"size":{"type":"integer","description":"The number of results to return per page.\n\nDefaults to 20, with a maximum of 100.\n","example":25}}}},{"name":"excludeNestedData","in":"query","description":"Exclude nested team data (lists, message templates, etc.) in the response body.","schema":{"type":"boolean"}}]}},"/organization-teams/{teamId}":{"get":{"tags":["Teams"],"summary":"Get a team","responses":{"200":{"description":"The request for a specific team was successful.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/GetTeamResult"}}}},"400":{"$ref":"#/components/responses/ErrorBadRequest"},"401":{"$ref":"#/components/responses/ErrorUnauthorized"},"403":{"$ref":"#/components/responses/ErrorForbidden"},"404":{"$ref":"#/components/responses/ErrorNotFound"},"412":{"$ref":"#/components/responses/ErrorPreconditionFailed"},"500":{"$ref":"#/components/responses/ErrorUnhandled"}},"parameters":[{"name":"teamId","in":"path","description":"The ID of the team to upload these assets for","schema":{"description":"The ID of the team to upload these assets for","type":"number"},"required":true}]},"put":{"tags":["Teams"],"summary":"Update team","requestBody":{"required":true,"content":{"application/json":{"schema":{"$ref":"#/components/schemas/UpdateTeamRequestBody"}}}},"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/UpdateTeamResult"}}}},"400":{"$ref":"#/components/responses/ErrorBadRequest"},"401":{"$ref":"#/components/responses/ErrorUnauthorized"},"403":{"$ref":"#/components/responses/ErrorForbidden"},"404":{"$ref":"#/components/responses/ErrorNotFound"},"412":{"$ref":"#/components/responses/ErrorPreconditionFailed"},"500":{"$ref":"#/components/responses/ErrorUnhandled"}},"parameters":[{"name":"teamId","in":"path","description":"The ID of the team to upload these assets for","schema":{"description":"The ID of the team to upload these assets for","type":"number"},"required":true}]}},"/organization-teams/{teamId}/assets/{assetType}":{"post":{"tags":["Teams"],"summary":"Upload team assets","description":"Upload a team logo or icon image. Accepts PNG files only. Logo images must be at least 369x102 (WxH). Icon images must be at least 180x180.","requestBody":{"required":true,"content":{"multipart/form-data":{"schema":{"type":"object","properties":{"asset":{"type":"string","format":"binary"}}}}}},"responses":{"200":{"description":"Request Successful","content":{"application/json":{"schema":{"$ref":"#/components/schemas/PostTeamAssetByTypeResult"}}}},"400":{"$ref":"#/components/responses/ErrorBadRequest"},"401":{"$ref":"#/components/responses/ErrorUnauthorized"},"403":{"$ref":"#/components/responses/ErrorForbidden"},"404":{"$ref":"#/components/responses/ErrorNotFound"},"412":{"$ref":"#/components/responses/ErrorPreconditionFailed"},"500":{"$ref":"#/components/responses/ErrorUnhandled"}},"parameters":[{"name":"assetType","in":"path","required":true,"description":"The type of asset to upload","schema":{"type":"string","enum":["icon","logo"]}},{"name":"teamId","in":"path","description":"The ID of the team to upload these assets for","schema":{"description":"The ID of the team to upload these assets for","type":"number"},"required":true}]}},"/{organizationId}/organization-teams":{"get":{"tags":["Teams"],"summary":"Get a list of teams","responses":{"200":{"description":"The request for a list of existing teams was successful.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/GetTeamsResult"}}}},"400":{"$ref":"#/components/responses/ErrorBadRequest"},"401":{"$ref":"#/components/responses/ErrorUnauthorized"},"403":{"$ref":"#/components/responses/ErrorForbidden"},"404":{"$ref":"#/components/responses/ErrorNotFound"},"412":{"$ref":"#/components/responses/ErrorPreconditionFailed"},"500":{"$ref":"#/components/responses/ErrorUnhandled"}},"parameters":[{"$ref":"#/components/parameters/organizationId"},{"name":"sort","in":"query","style":"deepObject","explode":true,"description":"Sorting to order the results returned.\n\nThe order of properties is important, as sorting is applied in the order specified.\n\nDefaults to `name` `asc`.\n","schema":{"type":"object","properties":{"name":{"type":"string","description":"Sort by the name of the team.","enum":["asc","desc"],"example":"asc"},"created_at":{"type":"string","description":"Sort by the date/time when the team was created.","enum":["asc","desc"],"example":"asc"}}}},{"name":"page","in":"query","style":"deepObject","explode":true,"description":"Pagination to limit the number of results returned.\n\nDefaults to the first page of 20 results, with a maximum of 100 results per page.\n","schema":{"type":"object","properties":{"number":{"type":"integer","description":"The page number to return.\n\nDefaults to 1.\n","example":3},"size":{"type":"integer","description":"The number of results to return per page.\n\nDefaults to 20, with a maximum of 100.\n","example":25}}}},{"name":"excludeNestedData","in":"query","description":"Exclude nested team data (lists, message templates, etc.) in the response body.","schema":{"type":"boolean"}}],"deprecated":true}},"/lists":{"get":{"tags":["Lists"],"summary":"Get lists","parameters":[{"name":"sort","in":"query","style":"deepObject","explode":true,"description":"Sorting to order the results returned.\n\nThe order of properties is important, as sorting is applied in the order specified.\n\nDefaults to `created_at` `asc`.\n","schema":{"type":"object","properties":{"name":{"type":"string","description":"Sort by the name of the list.","enum":["asc","desc"],"example":"asc"},"created_at":{"type":"string","description":"Sort by the date/time when the list was created.","enum":["asc","desc"],"example":"asc"},"updated_at":{"type":"string","description":"Sort by the date/time when the list was updated.","enum":["asc","desc"],"example":"asc"}}}},{"$ref":"#/components/parameters/page"}],"responses":{"200":{"description":"Request Successful","content":{"application/json":{"schema":{"$ref":"#/components/schemas/GetListsResult"}}}},"400":{"$ref":"#/components/responses/ErrorBadRequest"},"401":{"$ref":"#/components/responses/ErrorUnauthorized"},"403":{"$ref":"#/components/responses/ErrorForbidden"},"404":{"$ref":"#/components/responses/ErrorNotFound"},"412":{"$ref":"#/components/responses/ErrorPreconditionFailed"},"500":{"$ref":"#/components/responses/ErrorUnhandled"}}},"post":{"tags":["Lists"],"summary":"Create a list","requestBody":{"required":true,"content":{"application/json":{"schema":{"$ref":"#/components/schemas/CreateListBody"}}}},"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"allOf":[{"$ref":"#/components/schemas/ResponseData"},{"properties":{"id":{"type":"number","description":"The id of the newly created list"}}}]}}}},"400":{"$ref":"#/components/responses/ErrorBadRequest"},"401":{"$ref":"#/components/responses/ErrorUnauthorized"},"403":{"$ref":"#/components/responses/ErrorForbidden"},"404":{"$ref":"#/components/responses/ErrorNotFound"},"412":{"$ref":"#/components/responses/ErrorPreconditionFailed"},"500":{"$ref":"#/components/responses/ErrorUnhandled"}}}},"/lists/{listId}":{"get":{"tags":["Lists"],"summary":"Get a list","parameters":[{"$ref":"#/components/parameters/listId"}],"responses":{"200":{"description":"Request Successful","content":{"application/json":{"schema":{"$ref":"#/components/schemas/GetListResult"}}}},"400":{"$ref":"#/components/responses/ErrorBadRequest"},"401":{"$ref":"#/components/responses/ErrorUnauthorized"},"403":{"$ref":"#/components/responses/ErrorForbidden"},"404":{"$ref":"#/components/responses/ErrorNotFound"},"412":{"$ref":"#/components/responses/ErrorPreconditionFailed"},"500":{"$ref":"#/components/responses/ErrorUnhandled"}}},"put":{"tags":["Lists"],"summary":"Update a list","parameters":[{"$ref":"#/components/parameters/listId"}],"requestBody":{"required":true,"content":{"application/json":{"schema":{"$ref":"#/components/schemas/CreateListBody"}}}},"responses":{"200":{"description":"Request Successful","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ResponseData"}}}},"400":{"$ref":"#/components/responses/ErrorBadRequest"},"401":{"$ref":"#/components/responses/ErrorUnauthorized"},"403":{"$ref":"#/components/responses/ErrorForbidden"},"404":{"$ref":"#/components/responses/ErrorNotFound"},"412":{"$ref":"#/components/responses/ErrorPreconditionFailed"},"500":{"$ref":"#/components/responses/ErrorUnhandled"}}},"delete":{"tags":["Lists"],"summary":"Delete a list","parameters":[{"$ref":"#/components/parameters/listId"}],"responses":{"200":{"description":"Request Successful","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ResponseData"}}}},"400":{"$ref":"#/components/responses/ErrorBadRequest"},"401":{"$ref":"#/components/responses/ErrorUnauthorized"},"403":{"$ref":"#/components/responses/ErrorForbidden"},"404":{"$ref":"#/components/responses/ErrorNotFound"},"412":{"$ref":"#/components/responses/ErrorPreconditionFailed"},"500":{"$ref":"#/components/responses/ErrorUnhandled"}}}},"/operations/{operationId}":{"get":{"tags":["Operations"],"summary":"Get an existing operation to track its progress","parameters":[{"$ref":"#/components/parameters/operationId"}],"responses":{"200":{"description":"Request Successful","content":{"application/json":{"schema":{"$ref":"#/components/schemas/GetOperationResult"}}}},"400":{"$ref":"#/components/responses/ErrorBadRequest"},"401":{"$ref":"#/components/responses/ErrorUnauthorized"},"403":{"$ref":"#/components/responses/ErrorForbidden"},"404":{"$ref":"#/components/responses/ErrorNotFound"},"412":{"$ref":"#/components/responses/ErrorPreconditionFailed"},"500":{"$ref":"#/components/responses/ErrorUnhandled"}}}},"/text/welcome":{"put":{"tags":["Text"],"summary":"Send the original inspection request via text/email.","description":"The inspection request must be in a state of Created or Started.","requestBody":{"required":true,"content":{"application/json":{"schema":{"$ref":"#/components/schemas/SendWelcomeTextBody"}}}},"responses":{"200":{"description":"Request Successful","content":{"application/json":{"schema":{"$ref":"#/components/schemas/SendWelcomeTextResult"}}}},"400":{"$ref":"#/components/responses/ErrorBadRequest"},"401":{"$ref":"#/components/responses/ErrorUnauthorized"},"403":{"$ref":"#/components/responses/ErrorForbidden"},"404":{"$ref":"#/components/responses/ErrorNotFound"},"412":{"$ref":"#/components/responses/ErrorPreconditionFailed"},"500":{"$ref":"#/components/responses/ErrorUnhandled"}}}},"/text/request":{"put":{"tags":["Text"],"summary":"Send a request for more photos/videos via text/email.","description":"The inspection request must be in a state of Created, Started, In Progress, or Ready for Review. If in Ready for Review, the status is moved back to In Progress. To mark a list item as incomplete, include a list and set the `incomplete` property on the list item to `true`.","requestBody":{"required":true,"content":{"application/json":{"schema":{"$ref":"#/components/schemas/SendRequestMoreTextBody"}}}},"responses":{"200":{"description":"Request Successful","content":{"application/json":{"schema":{"$ref":"#/components/schemas/SendRequestMoreTextResult"}}}},"400":{"$ref":"#/components/responses/ErrorBadRequest"},"401":{"$ref":"#/components/responses/ErrorUnauthorized"},"403":{"$ref":"#/components/responses/ErrorForbidden"},"404":{"$ref":"#/components/responses/ErrorNotFound"},"412":{"$ref":"#/components/responses/ErrorPreconditionFailed"},"500":{"$ref":"#/components/responses/ErrorUnhandled"}}}},"/text/reminder":{"put":{"tags":["Text"],"summary":"Send a reminder to start the inspection via text/email.","requestBody":{"required":true,"content":{"application/json":{"schema":{"$ref":"#/components/schemas/SendReminderTextBody"}}}},"responses":{"200":{"description":"Request Successful","content":{"application/json":{"schema":{"$ref":"#/components/schemas/SendReminderTextResult"}}}},"400":{"$ref":"#/components/responses/ErrorBadRequest"},"401":{"$ref":"#/components/responses/ErrorUnauthorized"},"403":{"$ref":"#/components/responses/ErrorForbidden"},"404":{"$ref":"#/components/responses/ErrorNotFound"},"412":{"$ref":"#/components/responses/ErrorPreconditionFailed"},"500":{"$ref":"#/components/responses/ErrorUnhandled"}}}},"/text/reminder-to-finish":{"put":{"tags":["Text"],"summary":"Send a reminder to finish the inspection via text/email.","requestBody":{"required":true,"content":{"application/json":{"schema":{"$ref":"#/components/schemas/SendFinishReminderTextBody"}}}},"responses":{"200":{"description":"Request Successful","content":{"application/json":{"schema":{"$ref":"#/components/schemas/SendFinishReminderTextResult"}}}},"400":{"$ref":"#/components/responses/ErrorBadRequest"},"401":{"$ref":"#/components/responses/ErrorUnauthorized"},"403":{"$ref":"#/components/responses/ErrorForbidden"},"404":{"$ref":"#/components/responses/ErrorNotFound"},"412":{"$ref":"#/components/responses/ErrorPreconditionFailed"},"500":{"$ref":"#/components/responses/ErrorUnhandled"}}}},"/":{"get":{"tags":["General"],"summary":"Get API Status","description":"Can also use /online path","responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"allOf":[{"$ref":"#/components/schemas/ResponseData"}]}}}},"400":{"$ref":"#/components/responses/ErrorBadRequest"},"401":{"$ref":"#/components/responses/ErrorUnauthorized"},"403":{"$ref":"#/components/responses/ErrorForbidden"},"404":{"$ref":"#/components/responses/ErrorNotFound"},"412":{"$ref":"#/components/responses/ErrorPreconditionFailed"},"500":{"$ref":"#/components/responses/ErrorUnhandled"}}}},"/inspection-types":{"get":{"tags":["Inspection Types"],"summary":"Get a list of inspection types","parameters":[{"name":"filter","in":"query","explode":true,"style":"deepObject","description":"Filters to limit the results returned.","schema":{"type":"object","properties":{"team_id":{"type":"object","description":"Filter by one or more team ids.","properties":{"in":{"type":"array","items":{"type":"integer"},"example":[123,456]}}}}}},{"name":"sort","in":"query","style":"deepObject","explode":true,"description":"Sorting to order the results returned.\n\nThe order of properties is important, as sorting is applied in the order specified.\n\nDefaults to `created_at` `asc`.\n","schema":{"type":"object","properties":{"name":{"type":"string","description":"Sort by the name of the inspection type.","enum":["asc","desc"],"example":"asc"},"created_at":{"type":"string","description":"Sort by the date/time when the inspection type was created.","enum":["asc","desc"],"example":"asc"},"updated_at":{"type":"string","description":"Sort by the date/time when the inspection type was updated.","enum":["asc","desc"],"example":"asc"}}}},{"name":"include","in":"query","explode":true,"style":"deepObject","description":"Include related data in the response.","schema":{"type":"object","properties":{"include":{"type":"array","items":{"type":"string"},"description":"One or more of the following values: outcome_set, inspection_alert_config, list","example":["list","outcome_set","inspection_alert_config"]}}}},{"$ref":"#/components/parameters/page"}],"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/GetInspectionTypesResult"}}}},"400":{"$ref":"#/components/responses/ErrorBadRequest"},"401":{"$ref":"#/components/responses/ErrorUnauthorized"},"403":{"$ref":"#/components/responses/ErrorForbidden"},"404":{"$ref":"#/components/responses/ErrorNotFound"},"412":{"$ref":"#/components/responses/ErrorPreconditionFailed"},"500":{"$ref":"#/components/responses/ErrorUnhandled"}}},"post":{"tags":["Inspection Types"],"summary":"Create an inspection type","requestBody":{"required":true,"content":{"application/json":{"schema":{"$ref":"#/components/schemas/CreateInspectionTypeBody"}}}},"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"allOf":[{"$ref":"#/components/schemas/ResponseData"},{"properties":{"id":{"type":"number","description":"The id of the newly created inspection type"}}}]}}}},"400":{"$ref":"#/components/responses/ErrorBadRequest"},"401":{"$ref":"#/components/responses/ErrorUnauthorized"},"403":{"$ref":"#/components/responses/ErrorForbidden"},"404":{"$ref":"#/components/responses/ErrorNotFound"},"412":{"$ref":"#/components/responses/ErrorPreconditionFailed"},"500":{"$ref":"#/components/responses/ErrorUnhandled"}}}},"/inspection-types/{inspectionTypeId}":{"get":{"tags":["Inspection Types"],"summary":"Get an inspection type by id","parameters":[{"name":"inspectionTypeId","in":"path","required":true,"description":"Inspection type id","schema":{"type":"number"}}],"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/GetInspectionTypeResult"}}}},"400":{"$ref":"#/components/responses/ErrorBadRequest"},"401":{"$ref":"#/components/responses/ErrorUnauthorized"},"403":{"$ref":"#/components/responses/ErrorForbidden"},"404":{"$ref":"#/components/responses/ErrorNotFound"},"412":{"$ref":"#/components/responses/ErrorPreconditionFailed"},"500":{"$ref":"#/components/responses/ErrorUnhandled"}}},"put":{"tags":["Inspection Types"],"summary":"Update an inspection type","parameters":[{"name":"inspectionTypeId","in":"path","required":true,"description":"Inspection type id","schema":{"type":"number"}}],"requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","properties":{}}}}},"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/CreateInspectionTypeBody"}}}},"400":{"$ref":"#/components/responses/ErrorBadRequest"},"401":{"$ref":"#/components/responses/ErrorUnauthorized"},"403":{"$ref":"#/components/responses/ErrorForbidden"},"404":{"$ref":"#/components/responses/ErrorNotFound"},"412":{"$ref":"#/components/responses/ErrorPreconditionFailed"},"500":{"$ref":"#/components/responses/ErrorUnhandled"}}},"delete":{"tags":["Inspection Types"],"summary":"Delete an inspection type","parameters":[{"name":"inspectionTypeId","in":"path","required":true,"description":"Inspection type id","schema":{"type":"number"}}],"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"allOf":[{"$ref":"#/components/schemas/ResponseData"}]}}}},"400":{"$ref":"#/components/responses/ErrorBadRequest"},"401":{"$ref":"#/components/responses/ErrorUnauthorized"},"403":{"$ref":"#/components/responses/ErrorForbidden"},"404":{"$ref":"#/components/responses/ErrorNotFound"},"412":{"$ref":"#/components/responses/ErrorPreconditionFailed"},"500":{"$ref":"#/components/responses/ErrorUnhandled"}}}},"/message-template-sets":{"get":{"tags":["Message Template Sets"],"summary":"Get a list of message template sets","parameters":[{"name":"sort","in":"query","style":"deepObject","explode":true,"description":"Sorting to order the results returned.\n\nThe order of properties is important, as sorting is applied in the order specified.\n\nDefaults to `created_at` `asc`.\n","schema":{"type":"object","properties":{"name":{"type":"string","description":"Sort by the name of the list.","enum":["asc","desc"],"example":"asc"},"created_at":{"type":"string","description":"Sort by the date/time when the list was created.","enum":["asc","desc"],"example":"asc"},"updated_at":{"type":"string","description":"Sort by the date/time when the list was updated.","enum":["asc","desc"],"example":"asc"}}}},{"$ref":"#/components/parameters/page"}],"responses":{"200":{"description":"Request Successful","content":{"application/json":{"schema":{"$ref":"#/components/schemas/GetMessageTemplateSetsResult"}}}},"400":{"$ref":"#/components/responses/ErrorBadRequest"},"401":{"$ref":"#/components/responses/ErrorUnauthorized"},"403":{"$ref":"#/components/responses/ErrorForbidden"},"404":{"$ref":"#/components/responses/ErrorNotFound"},"412":{"$ref":"#/components/responses/ErrorPreconditionFailed"},"500":{"$ref":"#/components/responses/ErrorUnhandled"}}},"post":{"tags":["Message Template Sets"],"summary":"Create a message template set","requestBody":{"required":true,"content":{"application/json":{"schema":{"$ref":"#/components/schemas/CreateMessageTemplateSetBody"}}}},"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"allOf":[{"$ref":"#/components/schemas/ResponseData"},{"properties":{"id":{"type":"number","description":"The id of the newly created message template set"}}}]}}}},"400":{"$ref":"#/components/responses/ErrorBadRequest"},"401":{"$ref":"#/components/responses/ErrorUnauthorized"},"403":{"$ref":"#/components/responses/ErrorForbidden"},"404":{"$ref":"#/components/responses/ErrorNotFound"},"412":{"$ref":"#/components/responses/ErrorPreconditionFailed"},"500":{"$ref":"#/components/responses/ErrorUnhandled"}}}},"/message-template-sets/{messageTemplateSetId}":{"get":{"tags":["Message Template Sets"],"summary":"Get a message template set by id","parameters":[{"name":"messageTemplateSetId","in":"path","required":true,"description":"Message Template Set Id","schema":{"type":"number"}}],"responses":{"200":{"description":"Request Successful","content":{"application/json":{"schema":{"$ref":"#/components/schemas/GetMessageTemplateResult"}}}},"400":{"$ref":"#/components/responses/ErrorBadRequest"},"401":{"$ref":"#/components/responses/ErrorUnauthorized"},"403":{"$ref":"#/components/responses/ErrorForbidden"},"404":{"$ref":"#/components/responses/ErrorNotFound"},"412":{"$ref":"#/components/responses/ErrorPreconditionFailed"},"500":{"$ref":"#/components/responses/ErrorUnhandled"}}},"put":{"tags":["Message Template Sets"],"summary":"Update a message template set","parameters":[{"name":"messageTemplateSetId","in":"path","required":true,"description":"Message Template Set Id","schema":{"type":"number"}}],"requestBody":{"required":true,"content":{"application/json":{"schema":{"$ref":"#/components/schemas/CreateMessageTemplateSetBody"}}}},"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"allOf":[{"$ref":"#/components/schemas/ResponseData"}]}}}},"400":{"$ref":"#/components/responses/ErrorBadRequest"},"401":{"$ref":"#/components/responses/ErrorUnauthorized"},"403":{"$ref":"#/components/responses/ErrorForbidden"},"404":{"$ref":"#/components/responses/ErrorNotFound"},"412":{"$ref":"#/components/responses/ErrorPreconditionFailed"},"500":{"$ref":"#/components/responses/ErrorUnhandled"}}},"delete":{"tags":["Message Template Sets"],"summary":"Delete a message template set","responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"allOf":[{"$ref":"#/components/schemas/ResponseData"}]}}}},"400":{"$ref":"#/components/responses/ErrorBadRequest"},"401":{"$ref":"#/components/responses/ErrorUnauthorized"},"403":{"$ref":"#/components/responses/ErrorForbidden"},"404":{"$ref":"#/components/responses/ErrorNotFound"},"412":{"$ref":"#/components/responses/ErrorPreconditionFailed"},"500":{"$ref":"#/components/responses/ErrorUnhandled"}},"parameters":[{"name":"messageTemplateSetId","in":"path","required":true,"description":"Message Template Set Id","schema":{"type":"number"}}]}},"/open-api":{"get":{"tags":["OpenAPI"],"summary":"Get the public Vision OpenAPI definition","responses":{"200":{"description":"Returns an OpenAPI object detailing all public Vision API endpoints"},"400":{"$ref":"#/components/responses/ErrorBadRequest"},"401":{"$ref":"#/components/responses/ErrorUnauthorized"},"403":{"$ref":"#/components/responses/ErrorForbidden"},"404":{"$ref":"#/components/responses/ErrorNotFound"},"412":{"$ref":"#/components/responses/ErrorPreconditionFailed"},"500":{"$ref":"#/components/responses/ErrorUnhandled"}}}},"/webhooks":{"get":{"tags":["Webhooks"],"summary":"Get a list of all webhooks","responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"allOf":[{"$ref":"#/components/schemas/GetTeamWebhooksResult"}]}}}},"400":{"$ref":"#/components/responses/ErrorBadRequest"},"401":{"$ref":"#/components/responses/ErrorUnauthorized"},"403":{"$ref":"#/components/responses/ErrorForbidden"},"404":{"$ref":"#/components/responses/ErrorNotFound"},"412":{"$ref":"#/components/responses/ErrorPreconditionFailed"},"500":{"$ref":"#/components/responses/ErrorUnhandled"}}},"post":{"tags":["Webhooks"],"summary":"Create a webhook","requestBody":{"required":true,"content":{"application/json":{"schema":{"$ref":"#/components/schemas/TeamWebhookPayload"}}}},"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"allOf":[{"$ref":"#/components/schemas/ResponseData"},{"properties":{"id":{"type":"number","description":"The id of the newly created webhook"}}}]}}}},"400":{"$ref":"#/components/responses/ErrorBadRequest"},"401":{"$ref":"#/components/responses/ErrorUnauthorized"},"403":{"$ref":"#/components/responses/ErrorForbidden"},"404":{"$ref":"#/components/responses/ErrorNotFound"},"412":{"$ref":"#/components/responses/ErrorPreconditionFailed"},"500":{"$ref":"#/components/responses/ErrorUnhandled"}}}},"/webhooks/{webhookId}":{"get":{"tags":["Webhooks"],"summary":"Get a specific webhook","parameters":[{"name":"webhookId","in":"path","description":"The webhook id","required":true,"schema":{"type":"string"}}],"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"allOf":[{"$ref":"#/components/schemas/GetTeamWebhookResult"}]}}}},"400":{"$ref":"#/components/responses/ErrorBadRequest"},"401":{"$ref":"#/components/responses/ErrorUnauthorized"},"403":{"$ref":"#/components/responses/ErrorForbidden"},"404":{"$ref":"#/components/responses/ErrorNotFound"},"412":{"$ref":"#/components/responses/ErrorPreconditionFailed"},"500":{"$ref":"#/components/responses/ErrorUnhandled"}}},"put":{"tags":["Webhooks"],"summary":"Update a webhook","parameters":[{"name":"webhookId","in":"path","description":"The webhook id","required":true,"schema":{"type":"string"}}],"requestBody":{"required":true,"content":{"application/json":{"schema":{"$ref":"#/components/schemas/TeamWebhookPayload"}}}},"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"allOf":[{"$ref":"#/components/schemas/ResponseData"}]}}}},"400":{"$ref":"#/components/responses/ErrorBadRequest"},"401":{"$ref":"#/components/responses/ErrorUnauthorized"},"403":{"$ref":"#/components/responses/ErrorForbidden"},"404":{"$ref":"#/components/responses/ErrorNotFound"},"412":{"$ref":"#/components/responses/ErrorPreconditionFailed"},"500":{"$ref":"#/components/responses/ErrorUnhandled"}}},"delete":{"tags":["Webhooks"],"summary":"Delete a webhook","parameters":[{"name":"webhookId","in":"path","description":"The webhook id","required":true,"schema":{"type":"string"}}],"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"allOf":[{"$ref":"#/components/schemas/ResponseData"}]}}}},"400":{"$ref":"#/components/responses/ErrorBadRequest"},"401":{"$ref":"#/components/responses/ErrorUnauthorized"},"403":{"$ref":"#/components/responses/ErrorForbidden"},"404":{"$ref":"#/components/responses/ErrorNotFound"},"412":{"$ref":"#/components/responses/ErrorPreconditionFailed"},"500":{"$ref":"#/components/responses/ErrorUnhandled"}}}},"/website-forms":{"get":{"tags":["Website Forms"],"summary":"Get a list of all website forms","responses":{"200":{"description":"The request was successful.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/GetWebsiteFormsResult"}}}},"400":{"$ref":"#/components/responses/ErrorBadRequest"},"401":{"$ref":"#/components/responses/ErrorUnauthorized"},"403":{"$ref":"#/components/responses/ErrorForbidden"},"404":{"$ref":"#/components/responses/ErrorNotFound"},"412":{"$ref":"#/components/responses/ErrorPreconditionFailed"},"500":{"$ref":"#/components/responses/ErrorUnhandled"}}},"post":{"tags":["Website Forms"],"summary":"Create a website form","requestBody":{"required":true,"content":{"application/json":{"schema":{"$ref":"#/components/schemas/CreateWebsiteFormBody"}}}},"responses":{"201":{"description":"The request was successful.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/GetWebsiteFormResult"}}}},"400":{"$ref":"#/components/responses/ErrorBadRequest"},"401":{"$ref":"#/components/responses/ErrorUnauthorized"},"403":{"$ref":"#/components/responses/ErrorForbidden"},"404":{"$ref":"#/components/responses/ErrorNotFound"},"412":{"$ref":"#/components/responses/ErrorPreconditionFailed"},"500":{"$ref":"#/components/responses/ErrorUnhandled"}}}},"/website-forms/{websiteFormId}":{"get":{"tags":["Website Forms"],"summary":"Get a website form","parameters":[{"name":"websiteFormId","in":"path","description":"The ID of the website form.","required":true,"schema":{"type":"string"}}],"responses":{"200":{"description":"The request was successful.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/GetWebsiteFormResult"}}}},"400":{"$ref":"#/components/responses/ErrorBadRequest"},"401":{"$ref":"#/components/responses/ErrorUnauthorized"},"403":{"$ref":"#/components/responses/ErrorForbidden"},"404":{"$ref":"#/components/responses/ErrorNotFound"},"412":{"$ref":"#/components/responses/ErrorPreconditionFailed"},"500":{"$ref":"#/components/responses/ErrorUnhandled"}}},"put":{"tags":["Website Forms"],"summary":"Update a website form","parameters":[{"name":"websiteFormId","in":"path","description":"The ID of the website form.","required":true,"schema":{"type":"string"}}],"requestBody":{"required":true,"content":{"application/json":{"schema":{"$ref":"#/components/schemas/UpdateWebsiteFormBody"}}}},"responses":{"200":{"description":"The request was successful.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/GetWebsiteFormResult"}}}},"400":{"$ref":"#/components/responses/ErrorBadRequest"},"401":{"$ref":"#/components/responses/ErrorUnauthorized"},"403":{"$ref":"#/components/responses/ErrorForbidden"},"404":{"$ref":"#/components/responses/ErrorNotFound"},"412":{"$ref":"#/components/responses/ErrorPreconditionFailed"},"500":{"$ref":"#/components/responses/ErrorUnhandled"}}},"delete":{"tags":["Website Forms"],"summary":"Delete a website form","parameters":[{"name":"websiteFormId","in":"path","description":"The ID of the website form.","required":true,"schema":{"type":"string"}}],"responses":{"200":{"description":"The request was successful.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/DeleteWebsiteFormResult"}}}},"400":{"$ref":"#/components/responses/ErrorBadRequest"},"401":{"$ref":"#/components/responses/ErrorUnauthorized"},"403":{"$ref":"#/components/responses/ErrorForbidden"},"404":{"$ref":"#/components/responses/ErrorNotFound"},"412":{"$ref":"#/components/responses/ErrorPreconditionFailed"},"500":{"$ref":"#/components/responses/ErrorUnhandled"}}}}},"security":[{"AccessToken":[]},{"OAuth2ClientCredentials":[]}]}