Preview features are available to all users and receive the same level of support as generally available features. Schemas, fields, and behavior may still change before general availability (GA), and breaking changes are subject to a minimum 1-month deprecation notice, announced in the Teamwork Graph changelog.

To review the current limitations, see Limitations and considerations.

To share feedback or report an issue, visit the Atlassian developer community.

Represents a worker or employee from an external HR or workforce management system.

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 worker.

Field	Type	Description
`createdAt`	`DateTime`	Timestamp when the worker record was created.
`createdBy`	`User`	User who created this worker record.
`displayName`	`String`	Display name of the worker.
`externalId`	`ID`	Identifier of the worker in the external system.
`hiredAt`	`DateTime`	Timestamp when the worker was hired.
`id`	`ID!`	Unique identifier for the worker. This ID is globally unique across the entire Teamwork Graph.
`lastUpdatedAt`	`DateTime`	Timestamp of the most recent update to the worker record.
`lastUpdatedBy`	`User`	User who last updated this worker record.
`provider`	`ExternalProvider`	Provider or integration that supplies this worker.
`thirdPartyId`	`ID`	Additional identifier used by the third-party system.
`url`	`URL`	Direct URL to view the worker in its source system.
`workerUser`	`User`	User account associated with this worker.

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").

Available relationships

The following relationships are currently supported for External worker:

From relationships

To relationships

Relationships where External worker is the source object.

Relationship name	From object type	To object type
External worker fills external position	External worker	External position