The Teamwork Graph API is available through Forge's Early Access Program (EAP).
EAPs are offered to selected users for testing and feedback purposes. These features are unsupported and are subject to change without notice.
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 worker or employee from an external HR or workforce management system.
The Teamwork Graph API has the following fields and properties that you can use in your queries:
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. |
| 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"). |
The following relationships are currently supported for External worker:
Relationships where External worker is the target object.
| Relationship name | From object type | To object type |
|---|---|---|
| Talent worker links external worker | >> COULD NOT FIND | External worker |
| External worker fills external position | External position | External worker |
Rate this page: