transfer

get

/transfer/

Header parameters

X-Fieldsstring · mask

An optional fields mask

Responses

application/json

cURL

JavaScript

Python

HTTP

cURL

curl -L \
  --url '//www.data.gouv.fr/api/1/transfer/'

200

200

[
  {
    "comment": "text",
    "created": "2025-02-22T13:34:03.337Z",
    "id": "text",
    "reponse_comment": "text",
    "responded": "2025-02-22T13:34:03.337Z",
    "status": "pending",
    "owner": {
      "class": "text",
      "id": "text"
    },
    "recipient": {
      "class": "text",
      "id": "text"
    },
    "subject": {
      "class": "text",
      "id": "text"
    },
    "user": {
      "class": "text",
      "id": "text",
      "avatar": "text",
      "avatar_thumbnail": "text",
      "first_name": "text",
      "last_name": "text",
      "page": "text",
      "slug": "text",
      "uri": "text"
    }
  }
]

Success

Initiate transfer request

post

/transfer/

Header parameters

X-Fieldsstring · mask

An optional fields mask

Body

commentstringrequired

An explanation about the transfer request

recipientall ofrequired

The transfer recipient, either an user or an organization

subjectall ofrequired

The transfered subject

Responses

application/json

cURL

JavaScript

Python

HTTP

cURL

curl -L \
  --request POST \
  --url '//www.data.gouv.fr/api/1/transfer/' \
  --header 'Content-Type: application/json' \
  --data '{"comment":"text","recipient":{"class":"text","id":"text"},"subject":{"class":"text","id":"text"}}'

200

200

{
  "comment": "text",
  "created": "2025-02-22T13:34:03.337Z",
  "id": "text",
  "reponse_comment": "text",
  "responded": "2025-02-22T13:34:03.337Z",
  "status": "pending",
  "owner": {
    "class": "text",
    "id": "text"
  },
  "recipient": {
    "class": "text",
    "id": "text"
  },
  "subject": {
    "class": "text",
    "id": "text"
  },
  "user": {
    "class": "text",
    "id": "text",
    "avatar": "text",
    "avatar_thumbnail": "text",
    "first_name": "text",
    "last_name": "text",
    "page": "text",
    "slug": "text",
    "uri": "text"
  }
}

Success

Fetch a transfer request given its identifier

get

/transfer/{id}//

Path parameters

idstringrequired

Header parameters

X-Fieldsstring · mask

An optional fields mask

Responses

application/json

cURL

JavaScript

Python

HTTP

cURL

curl -L \
  --url '//www.data.gouv.fr/api/1/transfer/{id}/'

200

200

{
  "comment": "text",
  "created": "2025-02-22T13:34:03.337Z",
  "id": "text",
  "reponse_comment": "text",
  "responded": "2025-02-22T13:34:03.337Z",
  "status": "pending",
  "owner": {
    "class": "text",
    "id": "text"
  },
  "recipient": {
    "class": "text",
    "id": "text"
  },
  "subject": {
    "class": "text",
    "id": "text"
  },
  "user": {
    "class": "text",
    "id": "text",
    "avatar": "text",
    "avatar_thumbnail": "text",
    "first_name": "text",
    "last_name": "text",
    "page": "text",
    "slug": "text",
    "uri": "text"
  }
}

Success

Respond to a transfer request

post

/transfer/{id}//

Path parameters

idstringrequired

Header parameters

X-Fieldsstring · mask

An optional fields mask

Body

commentstring

An optional comment about the transfer response

responsestring · enumrequired

The response

Example: accept

Options: accept, refuse

Responses

application/json

cURL

JavaScript

Python

HTTP

cURL

curl -L \
  --request POST \
  --url '//www.data.gouv.fr/api/1/transfer/{id}/' \
  --header 'Content-Type: application/json' \
  --data '{"response":"accept"}'

200

200

{
  "comment": "text",
  "created": "2025-02-22T13:34:03.337Z",
  "id": "text",
  "reponse_comment": "text",
  "responded": "2025-02-22T13:34:03.337Z",
  "status": "pending",
  "owner": {
    "class": "text",
    "id": "text"
  },
  "recipient": {
    "class": "text",
    "id": "text"
  },
  "subject": {
    "class": "text",
    "id": "text"
  },
  "user": {
    "class": "text",
    "id": "text",
    "avatar": "text",
    "avatar_thumbnail": "text",
    "first_name": "text",
    "last_name": "text",
    "page": "text",
    "slug": "text",
    "uri": "text"
  }
}

Success