---
updatedAt: 2026-06-03T14:46:37.000Z
agentTools:
  projectIndex: https://developers.fieldwire.com/llms.txt
---

# Get sheet by ID

# OpenAPI definition

```json
{
  "openapi": "3.0.3",
  "info": {
    "title": "Fieldwire Regional API",
    "version": "v3"
  },
  "servers": [
    {
      "url": "https://client-api.{region}.fieldwire.com",
      "variables": {
        "region": {
          "default": "us",
          "enum": [
            "ca",
            "eu",
            "us"
          ]
        }
      }
    }
  ],
  "components": {
    "headers": {
      "current_user_id": {
        "description": "Current user's id",
        "schema": {
          "type": "integer"
        }
      }
    },
    "parameters": {
      "api_version": {
        "name": "Fieldwire-Version",
        "in": "header",
        "description": "Specifies the version of the API to talk to",
        "required": true,
        "schema": {
          "type": "string",
          "format": "date"
        }
      },
      "id": {
        "name": "id",
        "in": "path",
        "description": "ID of the entity",
        "required": true,
        "schema": {
          "type": "string",
          "format": "uuid"
        }
      },
      "project_id": {
        "name": "project_id",
        "in": "path",
        "description": "ID of the project this entity belongs to",
        "required": true,
        "schema": {
          "type": "string",
          "format": "uuid"
        }
      }
    },
    "schemas": {
      "sheet": {
        "type": "object",
        "description": "Entity that denotes a particular version of a plan",
        "required": [
          "id",
          "creator_user_id",
          "last_editor_user_id",
          "project_id",
          "is_multipage",
          "file_name",
          "name",
          "version",
          "resolved_conflict",
          "created_at",
          "device_created_at",
          "device_updated_at",
          "updated_at"
        ],
        "nullable": false,
        "properties": {
          "id": {
            "type": "string",
            "format": "uuid",
            "nullable": false,
            "description": "ID of the entity"
          },
          "creator_user_id": {
            "type": "integer",
            "format": "int32",
            "nullable": true,
            "description": "ID of the user who created this entity"
          },
          "last_editor_user_id": {
            "type": "integer",
            "format": "int32",
            "nullable": true,
            "description": "ID of the user who most recently edited this entity"
          },
          "user_id": {
            "type": "integer",
            "format": "int32",
            "nullable": true,
            "description": "ID of the user who uploaded this version"
          },
          "floorplan_id": {
            "type": "string",
            "format": "uuid",
            "nullable": true,
            "description": "ID of the plan this belongs to"
          },
          "folder_id": {
            "type": "string",
            "format": "uuid",
            "nullable": true,
            "description": "ID of the folder this lives in"
          },
          "rotate_degrees": {
            "type": "integer",
            "format": "int32",
            "nullable": false,
            "description": "Degrees by which the sheet is rotated between 0 to 360"
          },
          "project_id": {
            "type": "string",
            "format": "uuid",
            "nullable": false,
            "description": "ID of the project this entity belongs to"
          },
          "sheet_upload_id": {
            "type": "string",
            "format": "uuid",
            "nullable": true,
            "description": "ID of the uploaded entity this version was derived from"
          },
          "has_conflicts": {
            "type": "boolean",
            "nullable": true,
            "description": "Whether this has conflicts with other versions of the plan"
          },
          "has_errors": {
            "type": "boolean",
            "nullable": true,
            "description": "Whether this has any errors"
          },
          "has_low_res_tiles": {
            "type": "boolean",
            "nullable": true,
            "description": "Whether this has low resolution tile images"
          },
          "is_multipage": {
            "type": "boolean",
            "nullable": false,
            "description": "Whether this was derived out of a PDF with more than 1 page"
          },
          "is_tiled": {
            "type": "boolean",
            "nullable": true,
            "description": "Whether this carries tiles (rows & columns of images that can be put together to build this)"
          },
          "android_file_url": {
            "type": "string",
            "nullable": true,
            "description": "URL of the low resolution image of this entity (with a max dimension of 2048 pixels)"
          },
          "file_name": {
            "type": "string",
            "nullable": false,
            "description": "Name of the uploaded file out of which this was derived"
          },
          "file_url": {
            "type": "string",
            "nullable": true,
            "description": "URL of the low resolution image of this entity"
          },
          "name": {
            "type": "string",
            "nullable": false,
            "description": "Name of the entity"
          },
          "name_crop_url": {
            "type": "string",
            "nullable": true,
            "description": "URL of the corner of that carries the name"
          },
          "original_url": {
            "type": "string",
            "nullable": true,
            "description": "URL of the file that was processed into all the different images in this entity"
          },
          "suggested_name": {
            "type": "string",
            "nullable": true,
            "description": "Name suggested by our automated text extraction process"
          },
          "thumb_url": {
            "type": "string",
            "nullable": true,
            "description": "URL of the thumb image of this entity"
          },
          "tiles_package_url": {
            "type": "string",
            "nullable": true,
            "description": "URL of the zip file that carries all the tile images for this entity"
          },
          "version_description": {
            "type": "string",
            "nullable": true,
            "description": "Description for this version of the plan"
          },
          "meters_per_pixel": {
            "type": "number",
            "format": "double",
            "nullable": true,
            "description": "Count of meters each pixel in `file_url` corresponds to"
          },
          "pdf_height": {
            "type": "number",
            "format": "double",
            "nullable": true,
            "description": "Height of the original PDF file that was processed into this entity"
          },
          "pdf_width": {
            "type": "number",
            "format": "double",
            "nullable": true,
            "description": "Width of the original PDF file that was processed into this entity"
          },
          "android_file_height": {
            "type": "integer",
            "format": "int32",
            "nullable": true,
            "description": "Height in pixels of the `android_file_url` image"
          },
          "android_file_width": {
            "type": "integer",
            "format": "int32",
            "nullable": true,
            "description": "Width in pixels of the `android_file_url` image"
          },
          "file_height": {
            "type": "integer",
            "format": "int32",
            "nullable": true,
            "description": "Height in pixels of the `file_url` image"
          },
          "file_width": {
            "type": "integer",
            "format": "int32",
            "nullable": true,
            "description": "Width in pixels of the `file_url` image"
          },
          "original_height": {
            "type": "integer",
            "format": "int32",
            "nullable": true,
            "description": "Height in pixels of the original image before it was further processed into different dimensions"
          },
          "original_width": {
            "type": "integer",
            "format": "int32",
            "nullable": true,
            "description": "Height in pixels of the original image before it was further processed into different dimensions"
          },
          "page_number": {
            "type": "integer",
            "format": "int32",
            "nullable": true,
            "description": "Page number this entity denotes of the uploaded file"
          },
          "tile_size": {
            "type": "integer",
            "format": "int32",
            "nullable": true,
            "description": "Dimension of each tile image"
          },
          "tiles_resolution": {
            "type": "integer",
            "format": "int32",
            "nullable": true,
            "description": "Resolution of provided tiles images (in DPI)"
          },
          "tiles_resolution_type": {
            "type": "integer",
            "format": "int32",
            "nullable": true,
            "description": "Resolution type of tiles images"
          },
          "version": {
            "type": "integer",
            "format": "int32",
            "nullable": false,
            "description": "Particular version of the plan this entity denotes"
          },
          "version_notes": {
            "type": "string",
            "nullable": true,
            "description": "Notes for this version of the plan"
          },
          "resolved_conflict": {
            "type": "boolean",
            "nullable": true,
            "description": "Specifies if PUT/PATCH request was rejected - do not store this field!"
          },
          "created_at": {
            "type": "string",
            "format": "date-time",
            "nullable": false,
            "description": "Time when the server created the entity"
          },
          "deleted_at": {
            "type": "string",
            "format": "date-time",
            "nullable": true,
            "description": "Time the server deleted the entity"
          },
          "device_created_at": {
            "type": "string",
            "format": "date-time",
            "nullable": false,
            "description": "Time when the device created the entity"
          },
          "device_updated_at": {
            "type": "string",
            "format": "date-time",
            "nullable": false,
            "description": "Time when the device last updated the entity"
          },
          "updated_at": {
            "type": "string",
            "format": "date-time",
            "nullable": false,
            "description": "Time when the server last updated the entity"
          },
          "text_content_url": {
            "type": "string",
            "nullable": true,
            "description": "Parsed sheet's text content file url"
          }
        },
        "additionalProperties": false
      }
    },
    "securitySchemes": {
      "jwt": {
        "type": "http",
        "scheme": "bearer",
        "bearerFormat": "JWT",
        "description": "Access token (JWT) generated using the acquired refresh token (API token). Our [authentication](https://developers.fieldwire.com/docs/authentication) guide covers the steps to generate a valid token"
      }
    }
  },
  "paths": {
    "/api/v3/projects/{project_id}/sheets/{id}": {
      "get": {
        "summary": "Get sheet by ID",
        "operationId": "get_sheet_by_id",
        "tags": [
          "sheets"
        ],
        "security": [
          {
            "jwt": []
          }
        ],
        "parameters": [
          {
            "$ref": "#/components/parameters/project_id"
          },
          {
            "$ref": "#/components/parameters/id"
          },
          {
            "$ref": "#/components/parameters/api_version"
          }
        ],
        "responses": {
          "200": {
            "description": "Successful response",
            "headers": {
              "X-Current-User-Id": {
                "$ref": "#/components/headers/current_user_id"
              }
            },
            "content": {
              "application/json": {
                "example": {
                  "id": "788da667-0ec0-425e-930b-7070353d3b65",
                  "creator_user_id": null,
                  "last_editor_user_id": null,
                  "project_id": "34da34d5-7619-4b03-a443-1bc860eda979",
                  "resolved_conflict": false,
                  "created_at": "2026-10-02T14:52:46.578Z",
                  "updated_at": "2026-10-02T14:52:46.579Z",
                  "device_created_at": "2026-10-02T14:52:46.578Z",
                  "device_updated_at": "2026-10-02T14:52:46.578Z",
                  "deleted_at": null,
                  "name": "sheet.jpeg",
                  "file_name": "sheet.jpeg",
                  "version": 1,
                  "is_tiled": null,
                  "floorplan_id": null,
                  "file_width": null,
                  "file_height": null,
                  "original_width": null,
                  "original_height": null,
                  "has_conflicts": false,
                  "has_errors": false,
                  "tile_size": null,
                  "user_id": null,
                  "page_number": null,
                  "android_file_width": null,
                  "android_file_height": null,
                  "sheet_upload_id": null,
                  "suggested_name": null,
                  "version_description": null,
                  "version_notes": null,
                  "folder_id": null,
                  "rotate_degrees": 0,
                  "is_multipage": false,
                  "has_low_res_tiles": false,
                  "pdf_width": null,
                  "pdf_height": null,
                  "text_content_url": null,
                  "meters_per_pixel": null,
                  "tiles_package_url": null,
                  "file_url": "http://example.com/sheet.jpeg",
                  "thumb_url": "http://example.com/sheet.jpeg-thumb",
                  "original_url": "http://example.com/d2661023-077f-4926-b5cd-ae5e79ce67d3/sheet.jpeg",
                  "android_file_url": null,
                  "name_crop_url": null,
                  "tiles_resolution": null,
                  "tiles_resolution_type": null
                },
                "schema": {
                  "$ref": "#/components/schemas/sheet"
                }
              }
            }
          }
        }
      }
    }
  }
}
```