v1

latestOpenAPI 3.0.32026-07-246304082.0 MB

hyperlinks

Show all hyperlinks in a sheet

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

Path parameters

sheet_idstring uuid required

ID of the sheet to filter hyperlinks 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

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

attachment_idstring uuid nullable

ID of the attachment this links to

custom_symbol_idstring uuid nullable

ID of the custom symbol this links to

floorplan_idstring uuid nullable

ID of the plan this links too

form_idstring uuid nullable

ID of the form this links to

project_idstring uuid required

ID of the project this entity belongs to

sheet_idstring uuid required

ID of the sheet this links to

colorstring nullable

Color to be used for this link

descriptionstring nullable

A short description of the entity

pos_xinteger nullable

X coordinate of the pixel where the link is centered on the plan

pos_yinteger nullable

Y coordinate of the pixel where the link is centered on the plan

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 nullable 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