You must only install apps that call the Teamwork Graph API in test organizations. Apps calling the Teamwork Graph API require the read:graph:jiraor read:graph:confluence scope, which provides access to Teamwork Graph data across your entire organization. While apps still respect end-user permissions, this scope may grant access to sensitive information. For safety, only install these apps in organizations with test data. Do not install apps using this API in organizations with production data while this feature is in EAP.

Additionally, this EAP has significant limitations. To review the full list of limitations, see Limitations and considerations.

You must be part of this EAP in order to use the Teamwork Graph API. Express interest in joining through this form.

Represents a design artifact from an external design or creative tool. Designs include mockups, prototypes, wireframes, or visual assets integrated from third-party design platforms.

Available fields and properties

The Teamwork Graph API has the following fields and properties that you can use in your queries:

Object type fields are the core data fields of the object. Use these when you want to retrieve specific information about the object in your queries.
Cypher query properties are metadata properties used for filtering and traversing relationships between different object types in Teamwork Graph. Use Cypher query properties when you need to filter or navigate relationships between this object and other objects in your queries.

Object type fields

Cypher query properties

Object type fields

You can access these fields in the GraphiQL playground using the book icon in the top left, and then searching for External design.

Field	Type	Description
`createdAt`	`DateTime`	Timestamp when the design was created.
`createdBy`	`User`	User associated with this design's creation.
`description`	`String`	Description or summary of the design.
`displayName`	`String`	Display name of the design as shown in the source system.
`externalId`	`ID`	Identifier of the design in the external system. This is the native ID used by the third-party system to reference the design.
`iconUrl`	`URL`	URL to an icon or thumbnail image representing the design.
`id`	`ID!`	Unique identifier for the design. This ID is globally unique across the entire Teamwork Graph.
`lastUpdatedAt`	`DateTime`	Timestamp of the most recent update to the design.
`lastUpdatedBy`	`User`	User who last updated this design.
`provider`	`ExternalProvider`	Identifier of the external provider or integration that supplies this design. Links the design to its source system or integration.
`status`	`ExternalDesignStatus`	Current status of the design.
`type`	`ExternalDesignType`	Type or classification of the design.
`url`	`URL`	Direct URL to access or view the design in its source system.

Fields for ExternalProvider

Field	Type	Description
`id`	`ID!`	Unique identifier for the external provider.
`logoUrl`	`URL`	URL to the provider's logo image for UI display.
`name`	`String`	Display name of the provider (e.g., "Google Drive", "Dropbox", "GitHub").

Values for ExternalDesignStatus

Value	Description
`NONE`	No specific status assigned to the design.
`READY_FOR_DEVELOPMENT`	Design is complete and ready to be handed off to development.
`UNKNOWN`	Status is not recognized or cannot be determined.

Values for ExternalDesignType

Value	Description
`CANVAS`	A design canvas or artboard containing design elements.
`FILE`	A design file or document.
`GROUP`	A group or collection of design elements.
`NODE`	An individual node or component within a design.
`OTHER`	Other type of design artifact not covered by specific categories.
`PROTOTYPE`	An interactive prototype demonstrating user flows and interactions.

Available relationships

The following relationships are currently supported for External design:

To relationships

Relationships where External design is the target object.

Relationship name	From object type	To object type
Jira work item links external design	Jira work item	External design