Platform
    Atlassian Marketplace / Reference / Marketplace REST API (v3)

    Developer Space

    Postman Collection
    OpenAPI

    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.


    These APIs are currently in development and you can expect some minor changes in the coming months. These are expected to go live by October 2024.

    GET

    Get Developer Space by developer Id

    Returns the Developer Space entity, given its unique identifier, the developer Id.

    Request

    Path parameters

    developerId

    string

    Required

    Responses

    application/json

    DeveloperSpace
    GET/rest/3/developer-space/{developerId}
    1 2 3 4 curl --request GET \ --url 'https://api.atlassian.com/marketplace/rest/3/developer-space/{developerId}' \ --user 'email@example.com:<api_token>' \ --header 'Accept: application/json'
    200Response
    1 2 3 4 5 6 7 8 { "id": "<string>", "name": "<string>", "status": "ACTIVE", "type": "ATLASSIAN_INTERNAL", "vendorId": 37, "version": 22 }
    GET

    Get developer Id by vendor Id

    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.

    Request

    Path parameters

    vendorId

    number

    Required

    Responses

    application/json

    DeveloperId
    GET/rest/3/developer-space/vendor/{vendorId}
    1 2 3 4 curl --request GET \ --url 'https://api.atlassian.com/marketplace/rest/3/developer-space/vendor/{vendorId}' \ --user 'email@example.com:<api_token>' \ --header 'Accept: application/json'
    200Response
    1 2 3 { "developerId": "e33e3aca-c9fc-11ed-afa1-0242ac" }
    GET

    Get listings by developer Id

    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.

    Request

    Path parameters

    developerId

    string

    Required

    Responses

    application/json

    array<DeveloperListing>

    An array of objects representing the listings for Developer space.

    GET/rest/3/developer-space/{developerId}/listings
    1 2 3 4 curl --request GET \ --url 'https://api.atlassian.com/marketplace/rest/3/developer-space/{developerId}/listings' \ --user 'email@example.com:<api_token>' \ --header 'Accept: application/json'
    200Response
    1 2 3 4 5 6 7 8 9 10 11 12 13 14 15 16 17 18 19 20 21 22 23 24 25 26 27 28 29 30 31 32 33 34 35 36 37 38 39 [ { "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 } ]
    GET

    Get team member for Developer space

    Returns a specific team member associated with a particular Developer Space.

    Request

    Path parameters

    developerId

    string

    Required
    aaid

    string

    Required

    Responses

    application/json

    DeveloperMember
    GET/rest/3/developer-space/{developerId}/members/{aaid}
    1 2 3 4 curl --request GET \ --url 'https://api.atlassian.com/marketplace/rest/3/developer-space/{developerId}/members/{aaid}' \ --user 'email@example.com:<api_token>' \ --header 'Accept: application/json'
    200Response
    1 2 3 4 5 6 7 8 9 10 11 12 13 { "aaid": "<string>", "roles": [ { "roleId": "admin", "resourceType": "DEVELOPER_SPACE", "resourceId": "<string>" } ], "categories": [ "primary" ] }
    PUT

    Update member details for Developer Space

    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.

    Request

    Path parameters

    developerId

    string

    Required
    aaid

    string

    Required

    Request bodyapplication/json

    roles

    array<MemberRoles>

    categories

    array<string>

    Responses

    Successfully updated

    PUT/rest/3/developer-space/{developerId}/members/{aaid}
    1 2 3 4 5 6 7 8 9 10 11 12 13 14 15 16 curl --request PUT \ --url 'https://api.atlassian.com/marketplace/rest/3/developer-space/{developerId}/members/{aaid}' \ --user 'email@example.com:<api_token>' \ --header 'Content-Type: application/json' \ --data '{ "roles": [ { "roleId": "admin", "resourceType": "DEVELOPER_SPACE", "resourceId": "<string>" } ], "categories": [ "primary" ] }'
    POST

    Add user to Developer Space

    Adds a user as a team member to a specific Developer Space.

    Request

    Path parameters

    developerId

    string

    Required
    aaid

    string

    Required

    Request bodyapplication/json

    roles

    array<MemberRoles>

    categories

    array<string>

    Responses

    Successfully created

    POST/rest/3/developer-space/{developerId}/members/{aaid}
    1 2 3 4 5 6 7 8 9 10 11 12 13 14 15 16 curl --request POST \ --url 'https://api.atlassian.com/marketplace/rest/3/developer-space/{developerId}/members/{aaid}' \ --user 'email@example.com:<api_token>' \ --header 'Content-Type: application/json' \ --data '{ "roles": [ { "roleId": "admin", "resourceType": "DEVELOPER_SPACE", "resourceId": "<string>" } ], "categories": [ "primary" ] }'
    DEL

    Remove user as a team member

    Removes the user from the developer’s list of team members.

    Request

    Path parameters

    developerId

    string

    Required
    aaid

    string

    Required

    Responses

    Successfully deleted

    DEL/rest/3/developer-space/{developerId}/members/{aaid}
    1 2 3 curl --request DELETE \ --url 'https://api.atlassian.com/marketplace/rest/3/developer-space/{developerId}/members/{aaid}' \ --user 'email@example.com:<api_token>'
    GET

    Get developer’s team members

    Returns the list of developer’s team members.

    Request

    Path parameters

    developerId

    string

    Required

    Query parameters

    limit

    string

    cursor

    string

    Responses

    Successfully created

    application/json

    AllDeveloperMembers
    GET/rest/3/developer-space/{developerId}/members?limit={limit}&&cursor={cursor}
    1 2 3 4 curl --request GET \ --url 'https://api.atlassian.com/marketplace/rest/3/developer-space/{developerId}/members?limit={limit}&&cursor={cursor}' \ --user 'email@example.com:<api_token>' \ --header 'Accept: application/json'
    201Response
    1 2 3 4 5 6 7 8 9 10 11 12 13 14 15 16 17 18 { "members": [ { "aaid": "<string>", "roles": [ { "roleId": "admin", "resourceType": "DEVELOPER_SPACE", "resourceId": "<string>" } ], "categories": [ "primary" ] } ], "next": "<string>" }

    Rate this page: