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 job position or role from an external HR or recruitment 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 position.

Field	Type	Description
`createdAt`	`DateTime`	Timestamp when the position was created.
`createdBy`	`User`	User who created this position.
`displayName`	`String`	Display name of the position.
`externalId`	`ID`	Identifier of the position in the external system.
`id`	`ID!`	Unique identifier for the position. This ID is globally unique across the entire Teamwork Graph.
`jobTitle`	`String`	Job title for this position.
`lastUpdatedAt`	`DateTime`	Timestamp of the most recent update to the position.
`lastUpdatedBy`	`User`	User who last updated this position.
`parentId`	`ID`	Identifier of the parent organization or department.
`provider`	`ExternalProvider`	Provider or integration that supplies this position.
`status`	`String`	Current status of the position (e.g., "OPEN", "FILLED", "CLOSED").
`thirdPartyId`	`ID`	Additional identifier used by the third-party system.
`url`	`URL`	Direct URL to view the position 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").

Available relationships

The following relationships are currently supported for External position:

From relationships

To relationships

Relationships where External position is the source object.

Relationship name	From object type	To object type
External position manages external org	External position	External organisation
External position manages external position	External position	External position