Back to top

Transfer Requests

Project Transfer Requests Management

Create a transfer request
/projects/{id}/transfers

Organization owners can transfer their projects to other organizations.

  • Parameters
  • id
    string  (required) in path

    UUID of the project to be transferred

    transfer_request
     (required) in body

    Transfer Request to create

    {
    	"target_organization_id": "string"
    } 
  • Response  201   created
  • {
    	"id": "string",
    	"created_at": "string",
    	"updated_at": "string",
    	"target_organization": {
    		"href": "string"
    	},
    	"project": {
    		"href": "string"
    	},
    	"href": "string"
    } 
  • Response  401   unauthorized
  • Response  403   forbidden
  • Response  404   not found
  • Response  422   unprocessable entity
View a transfer request
GET
/transfers/{id}

Returns a single transfer request.

  • Parameters
  • id
    string  (required) in path

    Transfer request UUID

    include
    string in query

    related attributes to include

  •  
  • Response Body Show Hide
  • Request URL Show Hide
  • cURL Show Hide
  • Response  200   ok
  • {
    	"id": "string",
    	"created_at": "string",
    	"updated_at": "string",
    	"target_organization": {
    		"href": "string"
    	},
    	"project": {
    		"href": "string"
    	},
    	"href": "string"
    } 
  • Response  401   unauthorized
  • Response  403   forbidden
  • Response  404   not found
Accept a transfer request
PUT
/transfers/{id}

Accept a transfer request.

  • Parameters
  • id
    string  (required) in path

    Transfer request UUID

  • Response  204   no content
  • Response  401   unauthorized
  • Response  403   forbidden
  • Response  404   not found
Decline a transfer request
/transfers/{id}

Decline a transfer request.

  • Parameters
  • id
    string  (required) in path

    Transfer request UUID

  • Response  204   no content
  • Response  401   unauthorized
  • Response  403   forbidden
  • Response  404   not found
Retrieve all project transfer requests from or to an organization
GET
/organizations/{id}/transfers

Provides a collection of project transfer requests from or to the organization.

  • Parameters
  • id
    string  (required) in path

    Organization UUID

    include
    string in query

    related attributes to include

    page
    integer in query

    page to display, default to 1, max 100_000

    per_page
    integer in query

    items per page, default to 10, max 1_000

  •  
  • Response Body Show Hide
  • Request URL Show Hide
  • cURL Show Hide
  • Response  200   ok
  • {
    	"transfers": [
    		{
    			"id": "string",
    			"created_at": "string",
    			"updated_at": "string",
    			"target_organization": {
    				"href": "string"
    			},
    			"project": {
    				"href": "string"
    			},
    			"href": "string"
    		}
    	]
    } 
  • Response  401   unauthorized
  • Response  403   forbidden