{"openapi":"3.0.2","info":{"title":"Atlassian Marketplace API","version":"4"},"servers":[{"url":"https://api.atlassian.com/marketplace/"}],"tags":[{"name":"Developer Space","description":"Developer Space is an entity through which a developer, in the future, will have the ability to manage the entire lifecycle of the app, from development to deployment, and listing on the Atlassian Marketplace.\n"}],"paths":{"/rest/3/developer-space/{developerId}":{"servers":[{"url":"https://api.atlassian.com/rest/3"}],"get":{"tags":["Developer Space"],"summary":"Get Developer Space by developer Id","description":"Returns the Developer Space entity, given its unique identifier, the developer Id.","parameters":[{"name":"developerId","in":"path","description":"The unique identifier for this developer Space","required":true,"schema":{"type":"string"}}],"security":[{"mpac_authed":[]}],"responses":{"200":{"description":"","content":{"application/json":{"schema":{"$ref":"#/components/schemas/DeveloperSpace"}}}},"401":{"description":"Unauthorised"},"404":{"description":"The resource does not exist"}}}},"/rest/3/developer-space/vendor/{vendorId}":{"get":{"tags":["Developer Space"],"summary":"Get developer Id by vendor Id","description":"Returns the developer Id, given the vendor Id. The Marketplace vendor is uniquely identified by a numerical identifier. With the introduction of Developer Space, a unique Id known as “developer Id”, represented as a UUID, will replace the vendor Id used in existing APIs.","parameters":[{"name":"vendorId","in":"path","description":"The Marketplace vendor id.","required":true,"schema":{"type":"number"}}],"security":[{"mpac_authed":[]}],"responses":{"200":{"description":"","content":{"application/json":{"schema":{"$ref":"#/components/schemas/DeveloperId"}}}},"401":{"description":"Unauthorised"},"404":{"description":"The resource does not exist"}}}},"/rest/3/developer-space/{developerId}/listings":{"servers":[{"url":"https://api.atlassian.com/rest/3"}],"get":{"tags":["Developer Space"],"summary":"Get listings by developer Id","description":"Returns developer listings, given the developer Id. Developer listing refers to the details provided by the developer for their customers that may be displayed through an interface provided by the Atlassian ecosystem.","parameters":[{"name":"developerId","in":"path","description":"The unique identifier for this developer space","required":true,"schema":{"type":"string"}}],"security":[{"mpac_authed":[]}],"responses":{"200":{"description":"","content":{"application/json":{"schema":{"$ref":"#/components/schemas/DeveloperListings"},"example":[{"developerId":"e33e3aca-c9fc-11ed-afa1-0242ac","type":"DEVELOPER_CORE","content":{"description":"This is an example Developer listing.","slug":"example-developer","contactDetails":{"emailId":"example@example.com","phoneNumber":"123-456-7890","homepageUrl":"https://example.com","otherContactDetails":"other contact details"},"address":{"line1":"123 Example St","line2":"opp this building","city":"Example City","state":"Example State","postcode":"12345","isoCountryCode":"US"}},"version":1},{"developerId":"e33e3aca-c9fc-11ed-afa1-0242ac","type":"DEVELOPER_WEB","content":{"supportListing":{"supportContact":{"name":"Example Name","email":"example@domain.com","phone":"37129704579"}}},"version":1}]}}},"401":{"description":"Unauthorised"},"404":{"description":"The resource does not exist"}}}},"/rest/3/developer-space/{developerId}/members/{aaid}":{"post":{"tags":["Developer Space"],"summary":"Add user to Developer Space","description":"Adds a user as a team member to a specific Developer Space.","parameters":[{"name":"developerId","in":"path","description":"The unique identifier for this developer space","required":true,"schema":{"type":"string"}},{"name":"aaid","in":"path","description":"The AAID for user.","required":true,"schema":{"type":"string"}}],"requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/DeveloperMemberWrites"}}},"required":true},"security":[{"mpac_authed":[]}],"responses":{"201":{"description":"Successfully created"},"400":{"description":"Bad Request"},"401":{"description":"Unauthorised"}}},"put":{"tags":["Developer Space"],"summary":"Update member details for Developer Space","description":"Updates the roles and contact categories a particular member has in association with a particular Developer Space. Roles are assigned to members on the basis of the permissions they have, and Atlassian support can reach out to them for critical communications based on the contact category assigned to them.","parameters":[{"name":"developerId","in":"path","description":"The unique identifier for this developer space","required":true,"schema":{"type":"string"}},{"name":"aaid","in":"path","description":"The AAID for user.","required":true,"schema":{"type":"string"}}],"requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/DeveloperMemberWrites"}}},"required":true},"security":[{"mpac_authed":[]}],"responses":{"201":{"description":"Successfully updated"},"400":{"description":"Bad Request"},"401":{"description":"Unauthorised"}}},"get":{"tags":["Developer Space"],"summary":"Get team member for Developer space","description":"Returns a specific team member associated with a particular Developer Space.","parameters":[{"name":"developerId","in":"path","description":"The unique identifier for this developer space","required":true,"schema":{"type":"string"}},{"name":"aaid","in":"path","description":"The AAID for user.","required":true,"schema":{"type":"string"}}],"security":[{"mpac_authed":[]}],"responses":{"200":{"description":"","content":{"application/json":{"schema":{"$ref":"#/components/schemas/DeveloperMember"}}}},"400":{"description":"Bad Request"},"401":{"description":"Unauthorised"}}},"delete":{"tags":["Developer Space"],"summary":"Remove user as a team member","description":"Removes the user from the developer’s list of team members.","parameters":[{"name":"developerId","in":"path","description":"The unique identifier for this developer space","required":true,"schema":{"type":"string"}},{"name":"aaid","in":"path","description":"The AAID for user.","required":true,"schema":{"type":"string"}}],"security":[{"mpac_authed":[]}],"responses":{"200":{"description":"Successfully deleted"},"400":{"description":"Bad Request"},"401":{"description":"Unauthorised"}}}},"/rest/3/developer-space/{developerId}/members?limit={limit}&&cursor={cursor}":{"get":{"tags":["Developer Space"],"summary":"Get developer’s team members","description":"Returns the list of developer’s team members.","parameters":[{"name":"developerId","in":"path","description":"The unique identifier for this developer space","required":true,"schema":{"type":"string"}},{"name":"limit","in":"query","description":"If specified, limits the result set to this number of items. The maximum limit is 10.","required":false,"schema":{"type":"string"}},{"name":"cursor","in":"query","description":"Cursor indicates where the page results should start from.","required":false,"schema":{"type":"string"}}],"security":[{"mpac_authed":[]}],"responses":{"201":{"description":"Successfully created","content":{"application/json":{"schema":{"$ref":"#/components/schemas/AllDeveloperMembers"}}}},"400":{"description":"Bad Request"},"401":{"description":"Unauthorised"}}}}},"components":{"securitySchemes":{"mpac_authed":{"type":"http","scheme":"basic"}},"schemas":{"DeveloperListing":{"type":"object","description":"Developer listing refers to details provided by the Developer for its customers that might be displayed through an interface provided by Atlassian ecosystem.","required":["developerId","type","content"],"properties":{"developerId":{"type":"string","description":"Unique Identifier of the Developer."},"type":{"type":"string","description":"Type of the Developer Listing. DEVELOPER_CORE refers to core listing of Developer such as Developer's contact details and DEVELOPER_WEB refers to Developer's listing displayed on web such as Developer's logo and support details.","enum":["DEVELOPER_CORE","DEVELOPER_WEB"]},"content":{"type":"object","description":"Content of the Developer Listing based on the type of listing.","oneOf":[{"$ref":"#/components/schemas/DeveloperCoreListing"},{"$ref":"#/components/schemas/DeveloperWebListing"}]},"version":{"type":"number","description":"Version of the entity."}}},"DeveloperCoreListing":{"type":"object","required":["contactDetails"],"properties":{"description":{"type":"string","description":"Description of the Developer Listing."},"slug":{"type":"string","description":"Slug of the Developer Listing."},"contactDetails":{"type":"object","description":"Contact details of the Developer Listing.","$ref":"#/components/schemas/ContactDetails"},"address":{"type":"object","description":"Address of the Developer Listing.","$ref":"#/components/schemas/Address"}}},"ContactDetails":{"type":"object","required":["emailId"],"properties":{"emailId":{"type":"string","description":"Email Id of the Developer listing."},"phoneNumber":{"type":"string","description":"Phone number of the Developer listing."},"homepageUrl":{"type":"string","description":"Home page url of the Developer listing.","format":"uri"},"otherContactDetails":{"type":"string","description":"Other contact details of the Developer listing."}}},"Address":{"type":"object","properties":{"line1":{"type":"string","description":"Line 1 of the address."},"line2":{"type":"string","description":"Line 1 of the address."},"city":{"type":"string","description":"City of the address."},"state":{"type":"string","description":"State of the address."},"postcode":{"type":"string","description":"Postal Code of the address."},"isoCountryCode":{"type":"string","description":"ISO country code of the address."}}},"DeveloperWebListing":{"type":"object","properties":{"logo":{"type":"object","description":"Logo Image of the Developer Listing.","$ref":"#/components/schemas/LogoImage"},"supportListing":{"type":"object","description":"Support listing of the Developer.","$ref":"#/components/schemas/DeveloperSupportListing"}}},"LogoImage":{"type":"object","required":["original"],"properties":{"displayImage":{"type":"object","description":"Scaled Logo Image of the Developer listing.","$ref":"#/components/schemas/Image"},"unscaledImage":{"type":"object","description":"Original Logo Image of the Developer listing.","$ref":"#/components/schemas/Image"},"highResolutionImage":{"type":"object","description":"High resolution Logo Image of the Developer listing.","$ref":"#/components/schemas/Image"},"smallImage":{"type":"object","description":"Small Logo Image of the Developer listing.","$ref":"#/components/schemas/Image"},"smallHighResImage":{"type":"object","description":"Small High resolution Logo Image of the Developer listing.","$ref":"#/components/schemas/Image"}}},"Image":{"type":"object","required":["fileLink","filerType","fileId"],"properties":{"fileLink":{"type":"string","description":"Link of the image file."},"fileId":{"type":"string","description":"Identifier of the image file."},"fileType":{"type":"string","description":"Type of the image."}}},"DeveloperSupportListing":{"type":"object","required":["slaUrl"],"properties":{"supportContact":{"type":"object","description":"Support contact details for the Developer.","$ref":"#/components/schemas/SupportContact"},"slaUrl":{"type":"string","description":"Service level agreement Url for the Developer support.","format":"uri"},"targetResponseTimeInHrs":{"type":"integer","format":"int32","description":"Target response time in hours."},"supportHours":{"type":"object","description":"Support hours of the Developer.","$ref":"#/components/schemas/SupportHours"}}},"SupportHours":{"type":"object","required":["timezone","days","holidays"],"properties":{"timezone":{"type":"string","description":"Timezone of the Developer support listing."},"range":{"type":"object","description":"Time range of the Developer support listing.","$ref":"#/components/schemas/TimeRange"},"days":{"type":"array","description":"Working days of the Developer support listing.","items":{"type":"string","description":"Working day of the Developer support listing.","enum":["MONDAY","TUESDAY","WEDNESDAY","THURSDAY","FRIDAY","SATURDAY","SUNDAY"]}},"holidays":{"type":"array","description":"Holidays of the Developer support listing.","items":{"type":"object","$ref":"#/components/schemas/Holiday"}}}},"SupportContact":{"type":"object","required":["name"],"properties":{"name":{"type":"string","description":"Name of the Developer support listing."},"email":{"type":"string","description":"Email Id of the Developer support listing."},"phone":{"type":"string","description":"Phone number of the Developer support listing."},"emergencyContact":{"type":"string","description":"Emergency Contact of the Developer support listing.","format":"uri"},"url":{"type":"string","description":"Url of the Developer support listing.","format":"uri"}}},"TimeRange":{"type":"object","properties":{"from":{"type":"string","description":"Time range start time of the Developer support listing in format hh:mm:ss."},"to":{"type":"string","description":"Time range end time of the Developer support listing in format hh:mm:ss."}}},"Holiday":{"type":"object","required":["date","repeatAnnually","title"],"properties":{"title":{"type":"string","description":"The title of the holiday"},"date":{"type":"string","format":"date","description":"The date of the holiday"},"repeatAnnually":{"type":"boolean","description":"Indicates whether the holiday is a recurring annual holiday"}}},"ProgramEnrollments":{"type":"object","required":["enrollments"],"properties":{"enrollments":{"type":"array","description":"An array of objects representing the program enrollments for Developer space.","items":{"type":"object","$ref":"#/components/schemas/ProgramEnrollment"}}}},"DeveloperListings":{"type":"array","description":"An array of objects representing the listings for Developer space.","items":{"type":"object","$ref":"#/components/schemas/DeveloperListing"}},"DeveloperSpace":{"type":"object","required":["id","status","type","name"],"properties":{"id":{"type":"string","description":"Unique identifier of the Developer space."},"name":{"type":"string","description":"Unique name of the Developer space."},"status":{"type":"string","description":"Lifecycle status of the Developer space.","enum":["ACTIVE","INACTIVE","ARCHIVED"]},"type":{"type":"string","description":"Type of Developer space.","enum":["ATLASSIAN_INTERNAL","ATLASSIAN_EXTERNAL"]},"vendorId":{"type":"number","description":"Vendor Id associated with the entity."},"version":{"type":"number","description":"Version of the entity."}}},"ProgramEnrollment":{"type":"object","required":["programId","developerId","status"],"properties":{"programId":{"type":"string","description":"Unique Identifier of the program.","example":"38133e3a-c9fcd-afa1-024"},"programName":{"type":"string","description":"Name of the program developer space is enrolled in. "},"developerId":{"type":"string","description":"Unique Identifier of the Developer space.","example":"e33e3aca-c9fc-11ed-afa1-0242ac"},"status":{"type":"string","description":"Status of the Developer space membership in the program.","enum":["ACTIVE","INACTIVE","APPLIED"]},"startDate":{"type":"string","description":"Start date of the program.","format":"date","example":"20-10-2023"},"endDate":{"type":"string","description":"End date of the program.","format":"date","example":"20-10-2030"},"content":{"type":"string","description":"Content refers to the content associated with Developer space for a Developer program. This content should comply with schema associated with Developer Program.","example":"{\"type\":\"object\",\"properties\":{\"solutionPartnerLevel\":{\"type\":\"string\",\"enum\":[\"Silver\",\"Gold\",\"Platinum\"],\"title\":\"Solution Partner Level\"}},\"required\":[\"solutionPartnerLevel\"]}"},"version":{"type":"number","description":"Version of the entity."}}},"DeveloperId":{"type":"object","required":["developerId"],"properties":{"developerId":{"type":"string","description":"Unique identifier of the Developer space.","example":"e33e3aca-c9fc-11ed-afa1-0242ac"}}},"DeveloperMemberDetails":{"type":"object","required":["roles"],"properties":{"roles":{"type":"array","description":"Roles for the corresponding user","items":{"$ref":"#/components/schemas/MemberRoles"}},"categories":{"type":"array","description":"Categories","items":{"type":"string","enum":["primary","engineering","marketing","finance","support","security","migrations","salessupportandapprovals"]}}}},"AllDeveloperMembers":{"type":"object","required":["members"],"properties":{"members":{"type":"array","description":"List of all team members","items":{"$ref":"#/components/schemas/DeveloperMember"}},"next":{"type":"string","description":"Cursor indicating where the page results should start from"}}},"DeveloperMemberWrites":{"type":"object","properties":{"roles":{"type":"array","description":"Roles for the corresponding user","items":{"$ref":"#/components/schemas/MemberRoles"}},"categories":{"type":"array","description":"Categories","items":{"type":"string","enum":["primary","engineering","marketing","finance","support","security","migrations","salessupportandapprovals"]}}}},"DeveloperMember":{"type":"object","properties":{"aaid":{"type":"string","description":"Aaid of the user"},"roles":{"type":"array","description":"Roles for the corresponding user","items":{"$ref":"#/components/schemas/MemberRoles"}},"categories":{"type":"array","description":"Categories","items":{"type":"string","enum":["primary","engineering","marketing","finance","support","security","migrations","salessupportandapprovals"]}},"email":{"type":"string","description":"Email Id of the member"},"userName":{"type":"string","description":"Name of the member"}}},"MemberRoles":{"type":"object","required":["roleId","resourceType","resourceId"],"properties":{"roleId":{"type":"string","enum":["admin","partner-details-manager","listing-specialist","payment-details-manager","release-manager","pricing-specialist","promotions-manager","data-analyst","viewer"]},"resourceType":{"type":"string","enum":["DEVELOPER_SPACE"]},"resourceId":{"type":"string","description":"Unique Identity of the resource on which the role needs to be assigned (Developer Id for DEVELOPER_SPACE)"}}}}}}