Contact Us

If you still have questions or prefer to get help directly from an agent, please submit a request.
We’ll get back to you as soon as possible.

Please fill out the contact form below and we will reply as soon as possible.

  1. Fotoware Alto
    • 11.14 Schreckhorn
    • Terminology
    • Solutions
    • User Guide - Deutsch
    • User Guide - English
    • API Changelog
  2. Fotoware Veloz
    • Managing users and groups
    • Configuring archives
    • Configuring workflows
    • Configuring site behavior
    • Navigating and searching to find your assets
    • Working with your assets
    • Editing asset metadata
    • Uploading files
    • Version Control in Fotoware
    • Albums - Creating and sharing collections
    • Placing assets in a CMS
    • Working with the Fotoware Pro interface
    • Using the Fotoware plugins
    • Consent management
    • User guide to FotoWeb for iPad (Legacy)
    • Picture conferencing with FotoWeb Screens (Legacy)
    • What's what in Fotoware
    • GDPR
    • Fotoware Veloz releases
    • Activity Exports
    • Fotoware Example Workflows
  3. Fotostation
    • Getting started with Fotostation
    • Viewing, selecting and sorting files
    • Managing your assets with archives
    • Adding metadata to assets
    • Searching for assets
    • Working with your assets
    • Version Control in Fotostation
    • Automating tasks with Actions
    • Configuring metadata fields and editors
    • Configuring Fotostation
    • Configuring Fotostation for multi-user environments
    • Troubleshooting Fotostation
  4. Fotoware Flow
    • What is Flow?
    • Getting started
    • Flow dictionary
  5. Fotoware On-Premises
    • Getting started
    • Index Manager
    • FotoWeb
    • Color Factory
    • Connect
    • Operations Center Guide
  6. Integrations and APIs
    • The Fotoware API
    • Creating integrations using embeddable widgets
    • Authorizing applications using OAuth
    • Auto-tagging
    • FotoWeb Drag and Drop export
    • Integration using webhooks
    • Optimizely and Episerver plugin documentation
    • User Interface Integrations
  7. Fotoware Mobile
    • User guide for Fotoware Mobile for iPhone and Android
    • User guide to FotoWeb for iPad (Legacy)
    • User guide to FotoWeb for iPhone and Android (Legacy)

Contact Us

If you still have questions or prefer to get help directly from an agent, please submit a request.
We’ll get back to you as soon as possible.

Please fill out the contact form below and we will reply as soon as possible.

  • Support

Table of Contents

Introduction Methods GET annotations GET number of annotations POST new annotation GET single annotation Update annotation Delete annotation Representations Rectangle and ellipse annotation GET representation Pin annotation GET representation Polygon annotation GET representation Arrow annotation GET representation POST/PATCH Data Payload Rectangle and ellipse POST/PATCH data Pin POST/PATCH Data Polygon POST/PATCH Data Arrow POST/PATCH Data
  • Home
  • Integrations and APIs
  • The Fotoware API
  • Annotations API

Annotations API

05. April 2025

Elaine Foley

Table of Contents

Introduction Methods GET annotations GET number of annotations POST new annotation GET single annotation Update annotation Delete annotation Representations Rectangle and ellipse annotation GET representation Pin annotation GET representation Polygon annotation GET representation Arrow annotation GET representation POST/PATCH Data Payload Rectangle and ellipse POST/PATCH data Pin POST/PATCH Data Polygon POST/PATCH Data Arrow POST/PATCH Data

Introduction

Use the Annotations API to create integrations that create, update or delete annotations.

Methods

GET annotations

href: /fotoweb/archives/5001-News-archive/30/car.jpg.info.annotations/
method: GET
accept: [application/vnd.fotoware.annotation-list+json, application/json]

GET number of annotations

href: /fotoweb/archives/5001-News-archive/30/car.jpg.info.annotations/
method: GET
accept: application/vnd.fotoware.count+json

POST new annotation

href: /fotoweb/archives/5001-News-archive/30/car.jpg.info.annotations/
method: POST
content-type: application/vnd.fotoware.annotation+json

GET single annotation

href: /fotoweb/archives/5001-News-archive/30/car.jpg.info.annotations/<annotation-id>
method: GET
accept: [application/vnd.fotoware.annotation+json, application/json]

Update annotation

href: /fotoweb/archives/5001-News-archive/30/car.jpg.info.annotations/<annotation-id>
method: PATCH
content-type: application/vnd.fotoware.annotation+json

Delete annotation

href: /fotoweb/archives/5001-News-archive/30/car.jpg.info.annotations/<annotation-id>
method: DELETE

Representations

Rectangle and ellipse annotation GET representation

{

href: "/fotoweb/archives/5001-News-archive/30/haha2_1.jpg.annotations/d099724333979f0600051f99c3a8c63814dbfc327182daed0c5c6aa0e2f5654b",

fragmentHref: "#asset=/fotoweb/archives/5001-News-archive/30/haha2_1.jpg.info&annotation=/fotoweb/archives/5001-News-archive/30/haha2_1.jpg.annotations/d099724333979f0600051f99c3a8c63814dbfc327182daed0c5c6aa0e2f5654b",

type: "rectangle" || "ellipse",

text: "this is an annotation",

color: "#ff00aa",

allowUpdate: true,

allowDelete: true,

owner: {

name: "Martin Gunnerud",

avatarHref: "https://www.gravatar.com/ba2b64e29fdcbc449cbaffdd539b704c?d=mm"

},

props: {

comments: {

enabled: true,

count: 0,

 href: "/fotoweb/archives/5001-News-archive/30/haha2_1.jpg.annotations/d099724333979f0600051f99c3a8c63814dbfc327182daed0c5c6aa0e2f5654b/.comments/"
}
},

created: "2018-02-26T09:01:34.508000Z"

modified: "2018-02-28T09:01:34.508000Z",

left: 16.552643784786643,

top: 13.358070500927644,

width: 45.605287569573285,

height: 38.775510204081634

}

Pin annotation GET representation

{
 href: "/fotoweb/archives/5001-News-archive/30/haha2_1.jpg.annotations/d099724333979f0600051f99c3a8c63814dbfc327182daed0c5c6aa0e2f5654b",
 fragmentHref: "#asset=/fotoweb/archives/5001-News-archive/30/haha2_1.jpg.info&annotation=/fotoweb/archives/5001-News-archive/30/haha2_1.jpg.annotations/d099724333979f0600051f99c3a8c63814dbfc327182daed0c5c6aa0e2f5654b",
 type: "pin",
 text: "this is an annotation",
 color: "#ff00aa",
 allowUpdate: true,
 allowDelete: true,
 owner: {
   name: "Martin Gunnerud",
   avatarHref: “https://www.gravatar.com/ba2b64e29fdcbc449cbaffdd539b704c?d=mm”
 },
 props: {
   comments: {
     enabled: true,
     count: 0,
     href: “/fotoweb/archives/5001-News-archive/30/haha2_1.jpg.annotations/d099724333979f0600051f99c3a8c63814dbfc327182daed0c5c6aa0e2f5654b/.comments/”
   }
 },
 created: “2018-02-26T09:01:34.508000Z”
 modified: "2018-02-28T09:01:34.508000Z",
 left: 16.552643784786643,
 top: 13.358070500927644
}

Polygon annotation GET representation

{

 href: "/fotoweb/archives/5001-News-archive/30/haha2_1.jpg.annotations/d099724333979f0600051f99c3a8c63814dbfc327182daed0c5c6aa0e2f5654b",
 fragmentHref: "#asset=/fotoweb/archives/5001-News-archive/30/haha2_1.jpg.info&annotation=/fotoweb/archives/5001-News-archive/30/haha2_1.jpg.annotations/d099724333979f0600051f99c3a8c63814dbfc327182daed0c5c6aa0e2f5654b",
 type: "polygon",
 text: "this is an annotation",
 color: "#ff00aa",
 allowUpdate: true
 allowDelete: true,
 owner: {
   name: "Martin Gunnerud",
   avatarHref: “https://www.gravatar.com/ba2b64e29fdcbc449cbaffdd539b704c?d=mm”
 },
 props: {
   comments: {
     enabled: true,
     count: 0,
     href: “/fotoweb/archives/5001-News-archive/30/haha2_1.jpg.annotations/d099724333979f0600051f99c3a8c63814dbfc327182daed0c5c6aa0e2f5654b/.comments/”
   }
 },
 created: “2018-02-26T09:01:34.508000Z”
 modified: "2018-02-28T09:01:34.508000Z",
 coordinates:[
   {left: 18.1180426716141, top: 25.04638218923933},
   {left: 54.85273654916512, top: 11.50278293135436},
   {left: 73.32444341372913, top: 16.883116883116884},
   {left: 77.29012059369202, top: 47.49536178107606},
   {left: 56.000695732838594, top: 73.8404452690167},
   {left: 33.2502319109462, top: 62.894248608534326},
   {left: 39.19874768089054, top: 41.1873840445269},
   {left: 26.466836734693878, top: 45.82560296846011}
 ]
}

Arrow annotation GET representation

{
 href: "/fotoweb/archives/5001-News-archive/30/haha2_1.jpg.annotations/d099724333979f0600051f99c3a8c63814dbfc327182daed0c5c6aa0e2f5654b",
 fragmentHref: "#asset=/fotoweb/archives/5001-News-archive/30/haha2_1.jpg.info&annotation=/fotoweb/archives/5001-News-archive/30/haha2_1.jpg.annotations/d099724333979f0600051f99c3a8c63814dbfc327182daed0c5c6aa0e2f5654b",
 type: "arrow",
 text: "this is an arrow annotation",
 color: "#ff00aa",
 allowUpdate: true,
 allowDelete: true,
 owner: {
   name: "Martin Gunnerud",
   avatarHref: “https://www.gravatar.com/ba2b64e29fdcbc449cbaffdd539b704c?d=mm”
 },
 props: {
   comments: {
     enabled: true,
     count: 0,
     href: “/fotoweb/archives/5001-News-archive/30/haha2_1.jpg.annotations/d099724333979f0600051f99c3a8c63814dbfc327182daed0c5c6aa0e2f5654b/.comments/”
   }
 },
 created: “2018-02-26T09:01:34.508000Z”
 modified: "2018-02-28T09:01:34.508000Z",
 tailLeft: 16.552643784786643,
 tailTop: 13.358070500927644,
 headLeft: 56.000695732838594,
 headTop: 73.8404452690167,
}

POST/PATCH Data Payload

Rectangle and ellipse POST/PATCH data

{
 type: "rectangle" || "ellipse",  // (type is not included in PATCH request)
 text: "this is an annotation",
 color: "#ff00aa",
 left: 16.552643784786643,
 top: 13.358070500927644,
 width: 45.605287569573285,
 height: 38.775510204081634
}

Pin POST/PATCH Data

{
 type: "pin", // (type is not included in PATCH request)
 text: "this is an annotation",
 color: "#ff00aa",
 left: 16.552643784786643,
 top: 13.358070500927644
}

Polygon POST/PATCH Data

{
 type: "polygon", // (type is not included in PATCH request)
 text: "this is an annotation",
 color: "#ff00aa",
 coordinates:[
   {left: 18.1180426716141, top: 25.04638218923933},
   {left: 54.85273654916512, top: 11.50278293135436},
   {left: 73.32444341372913, top: 16.883116883116884},
   {left: 77.29012059369202, top: 47.49536178107606},
   {left: 56.000695732838594, top: 73.8404452690167},
   {left: 33.2502319109462, top: 62.894248608534326},
   {left: 39.19874768089054, top: 41.1873840445269},
   {left: 26.466836734693878, top: 45.82560296846011}
 ]
}

Arrow POST/PATCH Data

{
 type: "arrow",  // (type is not included in PATCH request)
 text: "this is an arrow annotation",
 color: "#ff00aa",
 tailLeft: 16.552643784786643,
 tailTop: 13.358070500927644,
 headLeft: 45.605287569573285,
 headTop: 38.775510204081634
}

 

markups api notes api

Was this article helpful?

Yes
No
Give feedback about this article

Related Articles

  • Content Relation Items Changed Condition
  • Content Schema Condition
  • What is Connect?
eco-lighthouse-miljøfyrtårn

Company

  • About us
  • Resellers
  • Careers
  • Contact us

Help & support

  • Support center
  • Consultancy
  • Tech partners
  • Fotostation
  • System status

Trust Center

  • Legal
  • Security
  • Sustainability & ESG

Locations

Fotoware AS (HQ)
Tollbugata 35
0157 OSLO
Norway
FotoWare Switzerland AG
Industriestrasse 25
5033 Buchs (AG)
Switzerland

Copyright 2025 Fotoware All rights reserved.

  • Terms of service
  • Privacy policy
  • Cookie policy

Knowledge Base Software powered by Helpjuice

Expand