Last updated Jul 16, 2025

Project

The Project object type represents a project object. atlassian:project should be used to ingest project-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:project
  ├─ key (string) [Optional]
  ├─ dueDate (string) [Optional]
  ├─ priority (string) [Optional]
  ├─ assignee (UserReference) [Optional]
      ├─ accountId (string) [Optional]
      ├─ email (string) [Optional]
      ├─ externalId (string) [Optional]
      ├─ ari (string) [Optional]
      ├─ name (string) [Optional]
      ├─ userName (string) [Optional]
      ├─ avatar (string) [Optional]
      └─ url (string) [Optional]
  ├─ status (string) [Required]
  ├─ attachments (List<Attachment>) [Optional]
      ├─ url (string) [Optional]
      ├─ thumbnailUrl (string) [Optional]
      ├─ title (string) [Optional]
      ├─ mimeType (string) [Optional]
      └─ byteSize (long) [Optional]
  ├─ labels (List<string>) [Optional]
  ├─ environment (string) [Optional]
  ├─ resolution (string) [Optional]
  ├─ votesCount (integer) [Optional]
  └─ watchersCount (integer) [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.

Project properties

Property	Type	Required	Description
`key`	`string`	No	A unique key identifier for the project.
`dueDate`	`string`	No	The due date for the project. Format: Instant (ISO8601 / RFC3339)
`priority`	`string`	No	The priority level of the project.
`assignee`	`UserReference`	No	The user assigned to the project.
`status`	`string`	Yes	The current status of the project.
`attachments`	`List<Attachment>`	No	List of attachments for the project. Maximum of 10 attachments allowed.
`attachments.url`	`string`	No	The URL of the attachment.
`attachments.thumbnailUrl`	`string`	No	The URL for the thumbnail of the attachment.
`attachments.title`	`string`	No	The title or name of the attachment.
`attachments.mimeType`	`string`	No	The MIME type of the attachment.
`attachments.byteSize`	`long`	No	The size of the attachment in bytes.
`labels`	`List<string>`	No	List of labels associated with the project.
`environment`	`string`	No	The environment associated with the project. Max length: 255 characters.
`resolution`	`string`	No	The resolution of the project. Max length: 255 characters.
`votesCount`	`integer`	No	The number of votes for the project.
`watchersCount`	`integer`	No	The number of watchers for the project.

Example payload

1
2
{
  "objects" : [ {
    "id" : "111212121",
    "updateSequenceNumber" : 1,
    "displayName" : "My project",
    "description" : "The project description",
    "url" : "https://www.example-project.com/share/projectId1",
    "lastUpdatedAt" : "2024-07-09T14:27:37.000Z",
    "createdBy" : {
      "externalId" : "external-id-1"
    },
    "createdAt" : "2024-04-16T09:31:32+00:00",
    "lastUpdatedBy" : {
      "externalId" : "external-id-1"
    },
    "permissions" : [ {
      "action" : "read",
      "accessControls" : [ {
        "principals" : [ {
          "type" : "EVERYONE"
        } ]
      } ]
    } ],
    "atlassian:project" : {
      "key" : "projectKey1",
      "priority" : "priority",
      "status" : "status",
      "environment" : "environment",
      "resolution" : "resolution",
      "votesCount" : 1,
      "watchersCount" : 1,
      "dueDate" : "2024-04-16T09:31:32+00:00",
      "assignee" : {
        "externalId" : "external-id-2"
      },
      "attachments" : [ {
        "url" : "https://example-project.com/files/img_4659.png",
        "mimeType" : "image/png",
        "title" : "title",
        "byteSize" : 140288
      } ],
      "labels" : [ "label1", "label2" ]
    }
  } ],
  "operationType" : "NORMAL"
}