Last updated Jul 16, 2025

Position

The Position object type represents a job position or role within an organization. atlassian:position should be used to ingest position-specific fields.

Payload structure

1
2
  objects {}
  ├─ schemaVersion (string) [Required]
  ├─ id (string) [Required]
  ├─ updateSequenceNumber (long) [Required]
  ├─ displayName (string) [Required]
  ├─ description (string) [Optional]
  ├─ url (string) [Required]
  ├─ createdAt (Instant (ISO8601 / RFC3339)) [Required]
  └─ createdBy [] [Optional]
      ├─ accountId (string)
      └─ ari (string)
  └─ lastUpdatedAt (Instant (ISO8601 / RFC3339)) [Required]
  └─ lastUpdatedBy [] [Required]
      ├─accountId (string)
      └─ ari
  └─ containerKey ()[Required]
      ├─ type
      └─ value
  └─ permissions 
      └─ accessControls
         └─ principals
            └─type
  └─ associations [] [Optional]
      ├─ associationType (string)
      └─ values []
      
  atlassian:position
  ├─ customAndSensitiveData (string) [Optional]
  ├─ status (string) [Required]
  └─ jobTitle (string) [Optional]

Common properties

Property	Type	Required	Description
`schemaVersion`	`string`	Yes	The schema version of the object.
`id`	`string`	Yes	The ID of the object in the source system.
`updateSequenceNumber`	`long`	Yes	A sequence number to compare when writing to the database. Objects are written following a last write wins strategy, therefore an object with a greater `UpdateSequenceNumber` is considered a more recently updated object.
`displayName`	`string`	Yes	The display name of the object.
`description`	`string`	No	The description of the object.
`url`	`string`	Yes	The URL from the provider which the object is accessible from.
`createdAt`	`string`	Yes	The date the object was created. Format: Instant (ISO8601 / RFC3339)
`createdBy`	`user`	No	The user that created the object. See User to learn more.
`lastUpdatedAt`	`string`	Yes	The date the object was last updated. Format: Instant (ISO8601 / RFC3339)
`lastUpdatedBy`	`user`	No	The user that last updated the object. See User to learn more.
`owners`	`list<User>`	No	List of users that own the object.
`thumbnail`	`thumbnail`	No	The thumbnail of the object. See Thumbnail to learn more.
`parentKey`	`entityKey`	No	The ID of the parent object. If null, it is a standalone object. See Entity key to learn more.
`containerKey`	`entityKey`	Yes	The container identifier that this object belongs to. See Entity key to learn more.
`permissions`	`list<Permissions>`	Yes	The permissions configuration of the object. See Permissions to learn more.
`associations`	`association`	No	List of objects associated with the object. Generally used to link an external object to a Atlassian object. See Association to learn more.

Position properties

Property Type Required Description

Property	Type	Required	Description
`customAndSensitiveData`	`string`	No	Custom and sensitive data associated with the position.
`status`	`string`	Yes	The current status of the position. Allowed values: `active`, `inactive`, `open`, `closed`, `filled`, `on_hold`, `archived`
`jobTitle`	`string`	No	The title of the job position.

customAndSensitiveData

string

Custom and sensitive data associated with the position.

status

string

Yes

The current status of the position.

Allowed values: active, inactive, open, closed, filled, on_hold, archived

jobTitle

string

The title of the job position.

Example payload

1
2
{
  "objects" : [ {
    "id" : "pos-1",
    "updateSequenceNumber" : 1,
    "displayName" : "pos 1",
    "createdAt" : "2024-04-16T09:01:32+00:00",
    "url" : "https://example-org.com/path-to-position",
    "lastUpdatedAt" : "2024-07-09T14:27:37.000Z",
    "parentKey" : {
      "type" : "atlassian:organisation",
      "value" : {
        "entityId" : "id of the org under which this position is"
      }
    },
    "permissions" : [ {
      "action" : "read",
      "accessControls" : [ {
        "principals" : [ {
          "type" : "EVERYONE"
        } ]
      } ]
    } ],
    "associations" : {
      "set" : [ {
        "associationType" : "atlassian:organisation",
        "values" : [ {
          "entityId" : "id of the org managed by this position"
        } ]
      }, {
        "associationType" : "atlassian:position",
        "values" : [ {
          "entityId" : "id of the position managed by this position"
        } ]
      }, {
        "associationType" : "atlassian:worker",
        "values" : [ {
          "entityId" : "id of the worker managed by this position"
        } ]
      } ]
    },
    "atlassian:position" : {
      "status" : "Filled",
      "jobTitle" : "Software Engineer"
    }
  } ]
}