Last updated Jul 16, 2025

Space

The Space object type represents a workspace or space object. atlassian:space should be used to ingest space-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
  └─ permissions 
      └─ accessControls
         └─ principals
            └─type
  └─ associations [] [Optional]
      ├─ associationType (string)
      └─ values []
      
  atlassian:space
  ├─ key (string) [Required]
  ├─ spaceType (string) [Required]
  ├─ subtype (string) [Required]
  ├─ icon.url (string) [Optional]
  ├─ icon.width (integer) [Required]
  ├─ icon.height (integer) [Required]
  ├─ icon.isDefault (boolean) [Required]
  └─ labels (List<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`	No	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.

Space properties

Property	Type	Required	Description
`key`	`string`	Yes	A unique key identifier for the space. Max length: 255 characters.
`spaceType`	`string`	Yes	The type of space. Max length: 255 characters.
`subtype`	`string`	Yes	The subtype of the space. Allowed values: `space` `project` `business` `software` `service_desk`
`icon`	`Icon`	No	Icon information for the space.
`icon.url`	`string`	No	The URL of the space icon.
`icon.width`	`integer`	Yes	The width of the space icon in pixels.
`icon.height`	`integer`	Yes	The height of the space icon in pixels.
`icon.isDefault`	`boolean`	Yes	Whether the icon is the default space icon.
`labels`	`List<string>`	No	Labels or tags associated with the space.

Example payload

1
2
{
  "objects" : [ {
    "id" : "siteId/spaceId1",
    "updateSequenceNumber" : 1,
    "displayName" : "My space",
    "description" : "The space contains work",
    "url" : "https://www.example-space.com/share/spaceId1",
    "lastUpdatedAt" : "2024-07-09T14:27:37.000Z",
    "permissions" : [ {
      "action" : "read",
      "accessControls" : [ {
        "principals" : [ {
          "type" : "EVERYONE"
        } ]
      } ]
    } ],
    "atlassian:space" : {
      "key" : "spaceKey1",
      "spaceType" : "personal",
      "subtype" : "space",
      "icon" : {
        "url" : "https://www.icon.com/1",
        "height" : 3,
        "width" : 3,
        "isDefault" : true
      },
      "labels" : [ "label1", "label2" ]
    }
  } ],
  "operationType" : "NORMAL"
}