Get all sheets in project

get

https://client-api.{region}.fieldwire.com/api/v3/projects/{project_id}/sheets

Path Params

project_id

uuid

required

ID of the project this entity belongs to

Query Params

last_synced_at

date-time

Timestamp since when further updates should be included

filters[creator_user_id_eq]

string

Filter on creator_user_id field being equal to the passed in value, allows for filtering with a array of values

filters[last_editor_user_id_eq]

string

Filter on last_editor_user_id field being equal to the passed in value, allows for filtering with a array of values

filters[floorplan_id_eq]

string

Filter on floorplan_id field being equal to passed in value, allows for filtering with a array of values

filters[folder_id_eq]

string

Filter on folder_id field being equal to passed in value, allows for filtering with a array of values

filters[file_name_like]

string

Filter on file_name field being like passed in value

filters[file_name_eq]

string

Filter on file_name field being equal to passed in value, allows for filtering with a array of values

filters[created_at_gte]

string

Filter on created_at field being greater than or equal to the passed in value

filters[created_at_gt]

string

Filter on created_at field being greater than the passed in value

filters[created_at_lte]

string

Filter on created_at field being less than or equal to the passed in value

filters[created_at_lt]

string

Filter on created_at field being less than to the passed in value

filters[name_like]

string

Filter on name field being like passed in value

filters[name_eq]

string

Filter on name field being equal to passed in value, allows for filtering with a array of values

filters[updated_at_gte]

string

Filter on updated_at field being greater than or equal to the passed in value

filters[updated_at_gt]

string

Filter on updated_at field being greater than the passed in value

filters[updated_at_lte]

string

Filter on updated_at field being less than or equal to the passed in value

filters[updated_at_lt]

string

Filter on updated_at field being less than to the passed in value

filters[version_gte]

string

Filter on version field being greater than or equal to the passed in value

filters[version_gt]

string

Filter on version field being greater than the passed in value

filters[version_lte]

string

Filter on version field being less than or equal to the passed in value

filters[version_lt]

string

Filter on version field being less than to the passed in value

filters[version_eq]

string

Filter on version field being equal to the passed in value, allows for filtering with a array of values

filters[meters_per_pixel_gte]

string

Filter on meters_per_pixel field being greater than or equal to the passed in value

filters[meters_per_pixel_gt]

string

Filter on meters_per_pixel field being greater than the passed in value

filters[meters_per_pixel_lte]

string

Filter on meters_per_pixel field being less than or equal to the passed in value

filters[meters_per_pixel_lt]

string

Filter on meters_per_pixel field being less than to the passed in value

filters[meters_per_pixel_eq]

string

Filter on meters_per_pixel field being equal to the passed in value, allows for filtering with a array of values

filters[deleted_at_gte]

string

Filter on deleted_at field being greater than or equal to the passed in value

filters[deleted_at_gt]

string

Filter on deleted_at field being greater than the passed in value

filters[deleted_at_lte]

string

Filter on deleted_at field being less than or equal to the passed in value

filters[deleted_at_lt]

string

Filter on deleted_at field being less than to the passed in value

filters[sheet_upload_id_eq]

string

Filter on sheet_upload_id field being equal to passed in value, allows for filtering with a array of values

Headers

Fieldwire-Version

date

required

Specifies the version of the API to talk to

Fieldwire-Filter

string

enum

Specifies if request should include active, deleted or all (default) entities

Allowed:

Fieldwire-Per-Page

integer

≤ 1000

Specifies the number of entities to include in the request

Response

200Successful response