v1

latestOpenAPI 3.0.32026-07-246304082.0 MB

markups

Show all markups in a sheet

get/api/v3/projects/{project_id}/sheets/{sheet_id}/markups

Path parameters

sheet_idstring uuid required

ID of the sheet to filter markups by

project_idstring uuid required

ID of the project this entity belongs to

Query parameters

last_synced_atstring date-time

Timestamp since when further updates should be included

filters[sheet_id_eq]string

Example:26462387-8f00-4118-8f1c-419ec8761c23

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

filters[creator_user_id_eq]string

Example:100

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

Example:100

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

filters[deleted_at_gte]string

Example:2009-06-15T13:45:30Z

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

filters[deleted_at_gt]string

Example:2009-06-15T13:45:30Z

Filter on deleted_at field being greater than the passed in value

filters[deleted_at_lte]string

Example:2009-06-15T13:45:30Z

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

filters[deleted_at_lt]string

Example:2009-06-15T13:45:30Z

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

filters[created_at_gte]string

Example:2009-06-15T13:45:30Z

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

filters[created_at_gt]string

Example:2009-06-15T13:45:30Z

Filter on created_at field being greater than the passed in value

filters[created_at_lte]string

Example:2009-06-15T13:45:30Z

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

filters[created_at_lt]string

Example:2009-06-15T13:45:30Z

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

filters[updated_at_gte]string

Example:2009-06-15T13:45:30Z

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

filters[updated_at_gt]string

Example:2009-06-15T13:45:30Z

Filter on updated_at field being greater than the passed in value

filters[updated_at_lte]string

Example:2009-06-15T13:45:30Z

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

filters[updated_at_lt]string

Example:2009-06-15T13:45:30Z

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

Headers

Fieldwire-Versionstring date required

Specifies the version of the API to talk to

Fieldwire-Filter'active' | 'deleted'

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

Fieldwire-Per-Pageinteger

Specifies the number of entities to include in the request

Response

Successful response

idstring uuid required

ID of the entity

creator_user_idinteger required

ID of the user who created this entity

last_editor_user_idinteger required

ID of the user who most recently edited this entity

project_idstring uuid required

ID of the project this entity belongs to

sheet_idstring uuid required

ID of the sheet this markup belongs to

is_privateboolean required

Whether this is a private markup

dataobject required

GeoJSON representation of a Markup. https://geojson.org/

created_atstring date-time required

Time when the server created the entity

deleted_atstring date-time nullable

Time the server deleted the entity

device_created_atstring date-time required

Time when the device created the entity

device_updated_atstring date-time required

Time when the device last updated the entity

resolved_conflictboolean required

Specifies if PUT/PATCH request was rejected - do not store this field!

updated_atstring date-time required

Time when the server last updated the entity