Graph (beta)

A third party can request information about all of the blocks, lines, connections, and text fields. No styling information will be returned. This API is in beta.

Any custom shape created or renamed after July 8th, 2013 will have a <customName> attribute as well

URL

https://www.lucidchart.com/api/graph/<document id>

OAuth parameters

required

Response

document
  documentId
  title
  version
  blocks
    id
    class
    customName (if present)
    textAreas
        textArea
            key
            value
        textArea
            key
            value
        ...*
    text (if present)
    link (if present)
    field (if present)
  lines
    id
    endpoint1
      style
      text (if present)
      line (if connected to line)
      block (if connected to block)
    endpoint2
      * see endpoint1

Example

https://www.lucidchart.com/api/graph/4e8cc0f9-69f8-4d42-9993-0d5633ee25f2

<document>
  <documentId>4e8cc0f9-69f8-4d42-9993-0d5633ee25f2</documentId>
  <title>asd</title>
  <version>70</version>
   <blocks>
     <block>
     <id>Sh6DwyXm4ZYP</id>
     <class>ERDEntityBlock</class>
     <field>Field</field>
     <field>Field</field>
   </block>
     <block>
     <id>Qn6DHVIX_Z_J</id>
     <class>ProcessBlock</class>
     <text>Process</text>
   </block>
     <block>
     <id>gx6D89zN5VyN</id>
     <class>OffPageLinkBlock</class>
     <link>ext:https://www.lucidchart.com</link>
     <text>Off-Page Link</text>
   </block>
  </blocks>
    <lines>
     <line>
     <id>Ei6DlbvpCxJz</id>
       <endpoint1>
       <style>None</style>
     </endpoint1>
      <endpoint2>
      <style>Arrow</style>
     </endpoint2>
   </line>
    <line>
     <id>Gi6DFkSl4VEu</id>
      <endpoint1>
      <style>None</style>
      <block>Sh6DwyXm4ZYP</block>
     </endpoint1>
      <endpoint2>
      <style>Arrow</style>
      <line>Ei6DlbvpCxJz</line>
     </endpoint2>
     <text>right here</text>
   </line>
  </lines>
</document>

Documentation

Client side debugging

To see what the graph API will give you from a server side call, without having to make a server call, you can open a document in Chrome, open the javascript console (ctrl+shift+j) and type:

lucid.getGraphData()

This will output an XML string of the graph data for the selected blocks and lines, or if none are selected it will output the state of the entire document.

Shape Library Textarea Keys

  • Flowchart
    • Process Text
    • Decision Text
    • Terminator Text
    • Predefined Process Text
    • Document Text
    • Multiple Documents Text
    • Manual Input Text
    • Preparation Text
    • Data (I/O) Text
    • Database Text
    • Direct Access Storage (Hard Disk) Text
    • Internal Storage Text
    • Paper Tape Text
    • Manual Operation Text
    • Delay Text
    • Stored Data Text
    • Merge Text
    • Connector Text
    • Display Text
    • Off-Page Link Text
    • Note Text
    • Swim Lane Lane_##
  • Geometric Shapes
    • Isosceles Triangle Text
    • Right Triangle Text
    • Pentagon Text
    • Hexagon Text
    • Octagon Text
    • Cross Text
    • Right Arrow Text
    • Cloud Text
    • Heart Text
    • Star Text
    • LeftArrow Text
    • Up Arrow Text
    • DownArrow Text
    • Callout Tip
  • Entity Relationship
    • ERDEntityBlock Name, Field[row #]
    • ERDEntityBlock2 Name, Key[row #], Field[row #]
    • ERDEntityBlock3 Name, Field[row #], Type[row #]
    • ERDEntityBlock4 Name, Key[row #], Field[row #], Type[row #]
  • UML
    • Class Title,Text1,Text2
    • Active Class Text
    • Simple Class Title,Text1,Text2
    • Interface Title,Text1,Text2
    • Simple Interface Title,Text1,Text2
    • Multiplicity Text
    • Package Title,Text
    • Constraint Text
    • Note Text
    • Text Text
    • Actor Text
    • Use Case Text,ExtensionPoints,ExtensionPointLabel
    • Use Case (w/Extension Points) Text,ExtensionPoints,ExtensionPointLabel
    • Oval Container
    • Rectangle Container Text
    • Option Loop Title,Text
    • Start
    • State/Activity State,Action
    • Branch/Merge
    • Horizontal Fork/Join
    • Vertical Fork/Join
    • Flow Final
    • History Pseudostate
    • End
    • Object Text
    • Send Signal Text
    • Receive Signal Text
    • UML Object Text
    • Activation
    • Deletion
    • Alternative Title,Text,Else
    • Entity Text
    • Boundary Text
    • Control Text
    • Component Title
    • Node Title
    • UML Node Title
    • UML Node Instance Title
    • Weak Entity Text
    • Attribute Text
    • Multi Valued Attribute Text
    • Relationship Text
    • Weak Relationship Text
  • BPMN 2.0
    • Task Text
    • Transaction Text
    • Event Sub-Process Text
    • Call Activity Text
    • Start Event Text
    • Intermediate Event Text
    • End Event Text
    • Choreography Participant1,Name,TaskName
    • Conversation Text
    • Gateway Text
    • Data Object Text,Title
    • Data Store Text
    • Pool (White Box) MainText,Lane_0,Lane_1
    • Pool (White Box) MainText,Lane_0,Lane_1
    • Pool (Black Box) Text
  • Data Flow
    • External Entity Text
    • External Entity Text
    • Process Text
    • YDMDFDDataStore Text
    • Process Number,Text
    • Process Text
    • Data Store Number,Text
    • Data Store Text
  • Org Charts
    • Org ChartName,Role,Phone,Email
  • Value Stream
    • Customer/Supplier Text
    • Dedicated Process Title,Text
    • Shared Process Text,Resource
    • Workcell Text
    • Data Cell cell_1,cell_2,cell_3
    • Inventory Text
    • Supermarket cell_1,cell_2,cell_3
    • Physical Pull
    • FIFO Lane
    • Safety/Buffer Stock cell_1,cell_2,cell_3
    • External Shipment Airplane Text
    • External Shipment Forklift Text
    • External Shipment Truck Text
    • External Shipment Boat Text
    • Production Control Title,Resources
    • Other Information Text
    • Heijyunka Box Title,Text1,Text2
    • Sequenced Pull Ball
    • MRP/ERP Text
    • Load Leveling
    • Go See
    • Go See Production Text
    • Verbal Information
    • Kaizen Burst Text
    • Operator Text
    • Timeline tw_1,tw_2,TotalVA,TotalNVA
    • Quality Problem Text
    • Production Kanban Text
    • Production Kanban Batch Text
    • Withdrawal Kanban Text
    • Withdrawal Kanban Batch Text
    • Signal Kanban Text
    • Kanban Post
    • Shipment Arrow Text
    • Push Arrow
    • Electronic Information Arrow Title
  • AWS Architecture
    • Amazon EC2 Title,Text
    • Instance Title,Text
    • Instances Title
    • AMI Title
    • DB on Instance Title
    • Instance with CloudWatch Title
    • Elastic IP Title
    • Amazon Elastic MapReduce Title
    • Cluster Title
    • HDFS Cluster Title
    • Auto Scaling Title
    • S3 Bucket Title,Text
    • Bucket Title,Text
    • Bucket with Objects Title
    • Object Title,Text
    • AWS Import/Export Title
    • AWS Storage Gateway Service Title
    • EBS Title,Text
    • Volume Title,Text
    • Snapshot Title,Text
    • Amazon CloudFront Title
    • Download Distribution Title
    • Streaming Distribution Title
    • Edge Location Title
    • Amazon CloudWatch Title
    • Alarm Title
    • Elastic Load Balancer Title
    • AWS Direct Connect Title
    • Amazon Route 53 Title,Text
    • Hosted Zone Title,Text
    • Route Table Title,Top,Middle,Bottom
    • VPC Title
    • VPN Connection Title
    • VPN Gateway Title
    • Customer Gateway Title
    • Internet Gateway Title
    • Router Title
    • Amazon SimpleDB Title
    • Domain Title
    • Item Title
    • Items Title
    • Attribute Title
    • Attributes Title
    • Relational Database Title,Text
    • RDS DB Instance Title
    • RDS DB Instance Standby (Multi-AZ) Title
    • RDS DB Instance Read Replica Title
    • Oracle DB Instance Title
    • MySQL DB Instance Title
    • Amazon DynamoDB Title
    • Table Title
    • Amazon ElastiCache Title
    • Email Title
    • Simple Notification Title
    • Topic Text,Title
    • Email Notification Title
    • HTTP Notification Title
    • Simple Queue Service Title
    • Queue Title
    • Message Title
    • Decider Title
    • Worker Title
    • Template Title
    • Stack Title
    • AWS Elastic Beanstalk Title
    • Application Title
    • Amazon Mechanical Turk Title
    • Human Intelligence Tasks (HIT) Title
    • Assignment/Task Title
    • Workers Title
    • Requester Title
    • AWS Cloud Title
    • User Title
    • Users Title
    • Client Title
    • Mobile Client Title
    • Multimedia Title
    • Corporate data center Title
    • Traditional server Title
    • Internet Title
    • AWS Management Console Title
    • IAM Add-on Title
    • Example: IAM Add-on Title
    • Subnet Title
    • Auto Scaling Container Title
    • Availability Zone Title
    • Region Container Title
    • Security Group Container Title
    • Elastic Beanstalk Container Title
    • EC2 Instance Container Title
    • Subnet Container Title
    • VPC Container Title
    • AWS Cloud Container Title
    • Corporate Data Center Container Title
    • Server Contents Title
  • Cisco Network Icons
    • androgenous person Title
    • atm switch Title
    • cloud Title
    • fileserver Title
    • firewall Title
    • generic building Title
    • laptop Title
    • lock Title
    • microwebserver Title
    • pc Title
    • pda Title
    • phone Title
    • printer Title
    • relational database Title
    • router Title
    • standing man Title
    • standing woman Title
    • ups Title
    • wireless router Title
    • 100baset hub Title
    • 10700 Title
    • 10GE_FCoE Title
    • 15200 Title
    • 3174 (desktop) Title
    • 3200 mobile access router Title
    • 3x74 (floor) Title
    • 6700 series Title
    • 7500ars (7513) Title
    • access gateway Title
    • accesspoint Title
    • ace Title
    • ACS Title
    • adm Title
    • antenna Title
    • asic processor Title
    • ASR 1000 Series Title
    • ata Title
    • atm 3800 Title
    • atm fast gigabit etherswitch Title
    • atm router Title
    • atm tag switch router Title
    • avs Title
    • AXP Title
    • bbfw media Title
    • bbfw Title
    • bbsm Title
    • branch office Title
    • breakout box Title
    • bridge Title
    • broadband router Title
    • bts 10200 Title
    • cable modem Title
    • callmanager Title
    • car Title
    • carrier routing system Title
    • cddi-fddi Title
    • cdm Title
    • cellular phone Title
    • centri firewall Title
    • cisco 1000 Title
    • cisco asa 5500 Title
    • cisco ca Title
    • cisco file engine Title
    • cisco hub Title
    • ciscosecurity Title
    • Cisco telepresence manager Title
    • cisco unified presence server Title
    • cisco unityexpress Title
    • ciscoworks Title
    • class 4_5 switch Title
    • communications server Title
    • contact center Title
    • content engine (cache director) Title
    • content service router Title
    • content service switch 1100 Title
    • content switch module Title
    • content switch Title
    • content transformation engine (cte) Title
    • cs-mars Title
    • csm-s Title
    • csu_dsu Title
    • CUBE Title
    • detector Title
    • director-class fibre channel director Title
    • directory server Title
    • diskette Title
    • distributed director Title
    • dot-dot Title
    • dpt Title
    • dslam Title
    • dual mode ap Title
    • dwdm filter Title
    • end office Title
    • fax Title
    • fc storage Title
    • fddi ring Title
    • fibre channel disk subsystem Title
    • fibre channel fabric switch Title
    • file cabinet Title
    • file server Title
    • firewall service module (fwsm) Title
    • front end processor Title
    • gatekeeper Title
    • general applicance Title
    • generic gateway Title
    • generic processor Title
    • generic softswitch Title
    • gigabit switch atm tag router Title
    • government building Title
    • Ground terminal Title
    • guard Title
    • handheld Title
    • hootphone Title
    • host Title
    • hp mini Title
    • h Title
    • hub Title
    • iad router Title
    • ibm mainframe Title
    • ibm mini as400 Title
    • ibm tower Title
    • icm Title
    • ics Title
    • intelliswitch stack Title
    • ios firewall Title
    • ios slb Title
    • ip communicator Title
    • ip dsl Title
    • ip phone Title
    • ip Title
    • iptc Title
    • ip telephony router Title
    • iptv content manager Title
    • iptv server Title
    • iscsi router Title
    • isdn switch Title
    • itp Title
    • jbod Title
    • key Title
    • keys Title
    • lan to lan Title
    • layer 2 remote switch Title
    • layer 3 switch Title
    • lightweight ap Title
    • localdirector Title
    • longreach cpe Title
    • macintosh Title
    • mac woman Title
    • man_woman Title
    • mas gateway Title
    • mau Title
    • mcu Title
    • mdu Title
    • me 1100 Title
    • Mediator Title
    • meetingplace Title
    • mesh ap Title
    • metro 1500 Title
    • mgx 8000 multiservice switch Title
    • microphone Title
    • mini vax Title
    • mobile access ip phone Title
    • mobile access router Title
    • modem Title
    • moh server Title
    • MSE Title
    • mulitswitch device Title
    • multi-fabric server switch Title
    • multilayer remote switch Title
    • mux Title
    • MXE Title
    • nac appliance Title
    • NCE Title
    • NCE router Title
    • netflow router Title
    • netranger Title
    • netsonar Title
    • network management Title
    • Nexus 1000 Title
    • Nexus 2000 Title
    • Nexus 5000 Title
    • Nexus 7000 Title
    • octel Title
    • ons15500 Title
    • optical amplifier Title
    • optical services router Title
    • optical transport Title
    • pad Title
    • pad x Title
    • page icon Title
    • pbx Title
    • pbx switch Title
    • pc adapter card Title
    • pc man Title
    • pc routercard Title
    • pc software Title
    • pc video Title
    • phone_fax Title
    • pix firewall Title
    • pmc Title
    • programmable switch Title
    • protocol translator Title
    • pxf Title
    • radio tower Title
    • ratemux Title
    • repeater Title
    • RF modem Title
    • router_firewall Title
    • routerin building Title
    • router with silicon switch Title
    • route switch processor Title
    • rpsrps Title
    • running man Title
    • sattelite dish Title
    • sattelite Title
    • scanner Title
    • server switch Title
    • server with router Title
    • service control Title
    • Service Module Title
    • Service router Title
    • Services Title
    • Set top box Title
    • simulitlayer switch Title
    • sip proxy werver Title
    • sitting woman Title
    • small business Title
    • small hub Title
    • softphone Title
    • softswitch pgw mgc Title
    • software based server Title
    • Space router Title
    • speaker Title
    • ssc Title
    • ssl terminator Title
    • standard host Title
    • stb Title
    • storage router Title
    • storage server Title
    • stp Title
    • streamer Title
    • sun workstation Title
    • supercomputer Title
    • svx Title
    • system controller Title
    • tablet Title
    • tape array Title
    • tdm router Title
    • telecommuter house pc Title
    • telecommuter house Title
    • telecommuter icon Title
    • Telepresence 1000 Title
    • Telepresence 3000 Title
    • Telepresence 3200 Title
    • Telepresence 500 Title
    • terminal Title
    • token Title
    • TP MCU Title
    • transpath Title
    • truck Title
    • turret Title
    • tv Title
    • ubr910 Title
    • umg series Title
    • unity server Title
    • universal gateway Title
    • university Title
    • upc Title
    • vault Title
    • video camera Title
    • vip Title
    • virtual layer switch Title
    • virtual switch controller (vsc3000) Title
    • voice atm switch Title
    • voice commserver Title
    • voice router Title
    • voice switch Title
    • vpn concentrator Title
    • vpn gateway Title
    • VSS Title
    • wae Title
    • wavelength router Title
    • web browser Title
    • web cluster Title
    • wi-fi tag Title
    • wireless bridge Title
    • wireless location appliance Title
    • wireless Title
    • wireless transport Title
    • wism Title
    • wlan controller Title
    • workgroup director Title
    • workgroup switch Title
    • workstation Title
    • www server Title
  • Network Infrastructure
    • PC Title
    • Virtual-PC Title
    • Terminal Title
    • Data Pipe Title
    • Slate Device Title
    • Tablet Device Title
    • Laptop Device Title
    • PDA Title
    • CRT Monitor Title
    • LCD Monitor Title
    • A/B Switch Title
    • Repeater Title
    • Diagonstic Device Title
    • Card Reader Title
    • Patch Panel Title
    • Radio Tower Title
    • Biometric Reader Title
    • External Hard Drive Title
    • Web Service Title
    • Fiber Optic Title
    • Satellite Dish Title
    • Satellite Title
    • VoIP Phone Title
    • PBX Title
    • MLPS Title
    • Wireless Access Point Title
    • Ring Network Title
    • Ethernet Title
    • Server Title
    • External Media Drive Title
    • Mainframe Title
    • Router Title
    • Switch Title
    • Firewall Title
    • User Title
    • Comm-Link Title
    • Super Computer Title
    • Virtual Server Title
    • Printer Title
    • Plotter Title
    • Scanner Title
    • Copier Title
    • Fax Machine Title
    • Multi Function Machine Title
    • Projector Title
    • Projector Screen Title
    • Bridge Title
    • Hub Title
    • Modem Title
    • Telephone Title
    • Cell Phone Title
    • Smart Phone Title
    • Video Phone Title
    • Camera Title
    • Video Camera Title
  • Server Rack Diagrams
    • Server Rack Text
    • Blank Slot Text
    • RAID Array Text
    • Server Text
    • Ethernet Switch Text
    • Patch Panel Text
    • Router Text
    • Monitor Text
    • Slideout Keyboard Text
    • Power Strip Text
    • Power Supply Text
    • Bridge Text
    • Tape Drive Text
  • Tech Clipart
    • Server Title
    • File Server Title
    • Net Server Title
    • Net Server (Large) Title
    • RAID Device Title
    • Large RAID Device Title
    • Server Rack Title
    • Tape Backup Rack Title
    • Small Printer Title
    • Large Printer Title
    • Multipurpose Printer Title
    • Small Copier Title
    • Large Copier Title
    • Large-Format Printer Title
    • Router Title
    • Wireless Router Title
    • UPS Title
    • 2.0 Speakers Title
    • Slide Scanner Title
    • 2.1 Speakers Title
    • 5.1 Speakers Title
    • LCD Monitor Title
    • PDA Title
    • Memory Card Reader Title
    • Camcorder Title
    • Headset Title
    • Calculator Title
    • Flatbed Scanner Title
    • Photo Printer Title
    • Photo Scanner Title
    • Projector Title
    • External Drive (Firewire) Title
    • External Drive (USB) Title
    • External Modem Title
    • External TV Tuner Title
    • MP3 Player Title
    • External Sound Card (Box) Title
    • Wide-Screen LCD Title
    • 2.0 Speakers Title
    • 2.1 Speakers Title
    • 5.1 Speakers Title
    • Record Player Title
    • Headset Title
  • Circuit Diagrams
    • Amplifier Title
    • Operational Amplifier Title
    • Controlled Amplifier Title
    • Multiplexer
    • Demultiplexer
    • Capacitor 1 Title
    • Capacitor 2 Title
    • Diode
    • Resistor Title
    • Variable Resistor Title
    • Potentiometer Title
    • Protective Earth
    • Signal Ground
    • Transformer
    • _Inductor Title
    • _Variable Inductor Title
    • 2-Way Switch
    • On/Off Switch
    • Loudspeaker
    • Motor
    • LED1
    • Lightbulb
    • IC Pin0,Pin1,Pin2,Pin#,...,Title
    • AC Voltage Source Title
    • Voltage Source Title
    • Current Source Title
    • Controlled Current Source Title
    • Controlled Voltage Source Title
    • DC Voltage Source 1 Title
    • DC Voltage Source 2 Title
    • Vss
    • Vdd
    • BJT PNP
    • BJT NPN
    • JFET P-Channel
    • JFET N-Channel
    • MOSFET P-Channel 1
    • MOSFET P-Channel 2
    • MOSFET P-Channel 3
    • MOSFET N-Channel 1
    • MOSFET N-Channel 2
    • MOSFET N-Channel 3
    • Single Pole Single Throw (SPST)
    • Single Pole Double Throw (SPDT)
    • Double Pole Single Throw (DPST)
    • Double Pole Double Throw (DPDT)
    • AND
    • OR
    • Inverter
    • NAND
    • NOR
    • XOR
    • NXOR
    • D Type RS Flip Flop
    • D Type Flip Flop
    • D Type Flip Flop With Clear
    • RS Latch
    • Synchronous RS Latch
    • T Type Flip Flop
    • Positive
    • Negative
    • Inverter Contact
    • Voltmeter
    • Ammeter
    • Sine Wave
    • Sawtooth
    • Square Wave
  • Mind Mapping
    • Mind Map Node Text
  • Process Engineering
    • Agitator or Mixer
    • Air Cooled Exchanger
    • Boiler
    • Condenser
    • Diesel Motor
    • Double Flow Turbine
    • Double Pipe Heat
    • Vessel Text
    • Open Tank Text
    • Closed Tank Text
    • Storage Sphere Text
    • Column Text
    • Bag Text
    • Gas Cylinder Text
    • Gas Holder Text
    • Clarifier Text
    • Tank Text
    • Tray Column Text
    • Reaction Vessel Text
    • Boiler Text
    • Condenser Text
    • Cooling Tower Text
    • Heat Exchanger Text
    • Ejector / Injector Text
    • Compressor / Turbine Text
    • Motor Driven Turbine Text
    • Triple Fan Blades Text
    • Fan Blades Text
    • Centrifugal Pump Text
    • Gate Valve Text
    • Butterfly Valve Text
    • Ball Valve Text