Polarix.io
    Polarix.io
    • Introduction to the Polarix.io API
    • Polarix.io Interface & Branding
    • Authentication
      POST
    • Users
      GET
    • Project List
      GET
    • Project
      GET
    • Project Structure
      GET
    • Project Lexicon
      GET
    • Project Glossary
      GET
    • Project Tags
      GET
    • Project Items
      GET
    • Project Abbreviations
      GET
    • Project References
      GET
    • Project History
      GET

      Project References

      LIVE
      https://app.polarix.io
      LIVE
      https://app.polarix.io
      GET
      https://app.polarix.io
      /api/{version}/projects/{project_id}/references
      Retrieves Project references based on the {project_id} path parameter. Project ID is retrieved by calling the "Project List" endpoint.
      Filtering can be performed by providing a {section_id} and/or {item_id} parameter.

      Request

      Authorization
      Provide your bearer token in the
      Authorization
      header when making requests to protected resources.
      Example:
      Authorization: Bearer ********************
      Path Params
      version
      number 
      required
      Target API version
      Example:
      {{version}}
      project_id
      string 
      required
      Project ID retrieved by calling the "Project List" endpoint
      Example:
      6582ed0344adfe123d04f772
      Query Params
      section_id
      string 
      optional
      Section ID obtained by calling the "Project Structure" API endpoint
      Example:
      1
      item_id
      integer 
      optional
      item ID obtained by calling the "Project Items" API endpoint
      Example:
      2
      Header Params
      x-api-key
      string 
      required
      Example:
      1234abcd
      Accept
      string 
      optional
      use text/xml if XML is required
      Example:
      application/json

      Request samples

      Shell
      JavaScript
      Java
      Swift
      Go
      PHP
      Python
      HTTP
      C
      C#
      Objective-C
      Ruby
      OCaml
      Dart
      R
      Request Request Example
      Shell
      JavaScript
      Java
      Swift
      curl --location -g --request GET 'https://app.polarix.io/api/1.0/projects/6582ed0344adfe123d04f772/references?section_id=1&item_id=2' \
--header 'x-api-key: 1234abcd' \
--header 'Accept: application/json'

      Responses

      🟢200Success — JSON
      application/json
      Body
      array of:
      id
      integer 
      required
      title
      string 
      required
      section_id
      integer 
      required
      user_id
      integer 
      required
      pos
      integer 
      required
      status
      string 
      required
      parent_id
      null 
      required
      revisions_count
      integer 
      required
      prefix
      string 
      required
      children
      array [object {15}] 
      required
      id
      integer 
      required
      title
      null 
      required
      section_id
      integer 
      required
      user_id
      integer 
      required
      pos
      integer 
      required
      status
      string 
      required
      parent_id
      integer 
      required
      revisions_count
      integer 
      required
      prefix
      string 
      required
      children
      array [object {15}] 
      required
      section
      object 
      required
      subscription
      null 
      required
      contents
      array [object {14}] 
      required
      veeva_item
      null 
      required
      veeva_item_notes
      array[string]
      required
      section
      object 
      required
      id
      integer 
      required
      name
      string 
      required
      description
      null 
      required
      pos
      integer 
      required
      project_id
      integer 
      required
      parent_id
      null 
      required
      children
      array [object {7}] 
      required
      subscription
      null 
      required
      contents
      array [object {14}] 
      required
      id
      integer 
      required
      item_id
      integer 
      required
      project_country_id
      null 
      required
      text
      string 
      required
      clean_text
      string 
      required
      updated_at
      string 
      required
      commentsCount
      integer 
      required
      humanReadableUpdatedDate
      string 
      required
      comments
      array[string]
      required
      item_content_attachments
      array[string]
      required
      subscription
      null 
      required
      project_country
      null 
      required
      tags
      array[string]
      required
      reference_groups
      array[string]
      required
      veeva_item
      null 
      required
      veeva_item_notes
      array[string]
      required
      subscriptions
      array[string]
      required
      Example
      [
    {
        "id": 478,
        "attachment_id": 847,
        "reference_group_id": 429,
        "user_id": 2,
        "pos": 430,
        "created_at": "2021-12-13T17:57:09.000000Z",
        "updated_at": "2021-12-13T17:57:09.000000Z",
        "deleted_at": null,
        "old": true,
        "annotations": [
            {
                "id": 158962,
                "attachment_id": 847,
                "reference_id": 478,
                "title": null,
                "bodyValue": null,
                "motivation": null,
                "stylesheet_value": null,
                "source": null,
                "quadPoints": "[[70.863192949408,715.54359526372,307.84251247771,705.95263724435],[70.863192949408,703.90456808396,306.75271957939,695.59240446717],[70.863192949408,704.54396528525,306.75271957939,694.95300726588],[70.863192949408,692.90493810549,283.91413371863,684.5927744887],[70.863192949408,693.54433530678,283.91413371863,683.95337728741],[283.9323196986,693.05479682454,287.08934337998,687.93961921421],[283.9323196986,693.69419402583,287.08934337998,687.30022201292],[287.08934337998,692.90493810549,307.06293493298,684.5927744887],[287.08934337998,693.54433530678,307.06293493298,683.95337728741],[70.863192949408,681.90530812702,307.13162017921,673.59314451023],[70.863192949408,682.54470532831,307.13162017921,672.95374730893],[70.863192949408,670.90567814855,148.54620643837,662.59351453175],[70.863192949408,671.54507534984,148.54620643837,661.95411733046],[148.52997174381,671.04554628633,151.68699542519,665.930368676],[148.52997174381,671.68494348762,151.68699542519,665.2909714747],[151.68699542519,670.89568756728,302.83941670101,662.58352395048],[151.68699542519,671.53508476857,302.83941670101,661.94412674919],[302.03525296017,670.89568756728,304.8725780409,662.58352395048],[302.03525296017,671.53508476857,304.8725780409,661.94412674919],[70.873183530678,660.54544537137,304.88561262741,650.95448735199]]",
                "inkList": null,
                "subtype": null,
                "opacity": null,
                "strokeColor": null,
                "strokeWidth": null,
                "nodeIndex": null,
                "page": 1,
                "top": 0,
                "right": 0,
                "bottom": 0,
                "left": 0,
                "created_at_unix": 1688227072,
                "updated_at_unix": 1688227072,
                "user": null
            }
        ],
        "attachment": {
            "id": 847,
            "name": "Nguyen 2021 Cancers",
            "user_id": 2,
            "project_id": 37,
            "file": "https://lhg-digital.s3.amazonaws.com/polarixv2/attachments/60913765f15f9.pdf",
            "type": "pdf",
            "is_reference": 1,
            "contents": null,
            "pin": 0,
            "veeva_document_id": null,
            "initial_veeva_sync": 0,
            "created_at": "2021-12-13T17:57:06.000000Z",
            "updated_at": "2021-12-13T17:57:06.000000Z",
            "deleted_at": null,
            "reference_uses": 2,
            "created_at_formatted": "12/13/2021 17:12",
            "veeva_document": null
        }
    }
]
      🟢200Success — XML
      🟠401Unauthorized — JSON
      🟠401Unauthorized — XML
      🔴500Server Error — JSON
      🔴500Server Error — XML
      Previous
      Project Abbreviations
      Next
      Project History
      Built with