Managing Snags
Snags (also called issues or punch list items) track problems discovered during a project that need to be resolved.
List Snags
curl https://beta.renovatr.app/api/v1/projects/1/snags \
-H "X-API-KEY: your-api-key-here"
Get a Snag
curl https://beta.renovatr.app/api/v1/projects/1/snags/10 \
-H "X-API-KEY: your-api-key-here"
Create a Snag
curl -X POST https://beta.renovatr.app/api/v1/projects/1/snags \
-H "X-API-KEY: your-api-key-here" \
-H "Content-Type: application/json" \
-d '{
"title": "Cracked tile in bathroom",
"description": "Tile behind vanity has a hairline crack",
"priority": "high",
"status": "open",
"subcontractorId": 3
}'
Fields
| Field | Type | Required | Description |
|---|---|---|---|
title | string | Yes | Snag title |
description | string | No | Detailed description |
priority | string | No | low, medium, high, or critical |
status | string | No | open, in_progress, or resolved |
subcontractorId | integer | No | Responsible subcontractor |
Update a Snag
curl -X PATCH https://beta.renovatr.app/api/v1/projects/1/snags/10 \
-H "X-API-KEY: your-api-key-here" \
-H "Content-Type: application/json" \
-d '{ "status": "in_progress" }'
Resolve a Snag
To mark a snag as resolved, update its status:
curl -X PATCH https://beta.renovatr.app/api/v1/projects/1/snags/10 \
-H "X-API-KEY: your-api-key-here" \
-H "Content-Type: application/json" \
-d '{ "status": "resolved" }'
Delete a Snag
curl -X DELETE https://beta.renovatr.app/api/v1/projects/1/snags/10 \
-H "X-API-KEY: your-api-key-here"