transfer

get

Header parameters

X-Fieldsanyoptional

An optional fields mask

Responses

application/json

object[]optional

get

HTTPcURLJavaScriptPython

GET /api/1/transfer/ HTTP/1.1
Host: www.data.gouv.fr
Accept: */*

200

Success

[
  {
    "comment": "text",
    "created": "2025-04-15T08:13:38.703Z",
    "id": "text",
    "owner": {
      "class": "text",
      "id": "text"
    },
    "recipient": {
      "class": "text",
      "id": "text"
    },
    "reponse_comment": "text",
    "responded": "2025-04-15T08:13:38.703Z",
    "status": "pending",
    "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"
    }
  }
]

Initiate transfer request

post

Header parameters

X-Fieldsanyoptional

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

objectoptional

post

HTTPcURLJavaScriptPython

POST /api/1/transfer/ HTTP/1.1
Host: www.data.gouv.fr
Content-Type: application/json
Accept: */*
Content-Length: 98

{
  "comment": "text",
  "recipient": {
    "class": "text",
    "id": "text"
  },
  "subject": {
    "class": "text",
    "id": "text"
  }
}

200

Success

{
  "comment": "text",
  "created": "2025-04-15T08:13:38.703Z",
  "id": "text",
  "owner": {
    "class": "text",
    "id": "text"
  },
  "recipient": {
    "class": "text",
    "id": "text"
  },
  "reponse_comment": "text",
  "responded": "2025-04-15T08:13:38.703Z",
  "status": "pending",
  "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"
  }
}

Fetch a transfer request given its identifier

get

Path parameters

idanyrequired

Header parameters

X-Fieldsanyoptional

An optional fields mask

Responses

application/json

objectoptional

get

HTTPcURLJavaScriptPython

GET /api/1/transfer/{id}/ HTTP/1.1
Host: www.data.gouv.fr
Accept: */*

200

Success

{
  "comment": "text",
  "created": "2025-04-15T08:13:38.703Z",
  "id": "text",
  "owner": {
    "class": "text",
    "id": "text"
  },
  "recipient": {
    "class": "text",
    "id": "text"
  },
  "reponse_comment": "text",
  "responded": "2025-04-15T08:13:38.703Z",
  "status": "pending",
  "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"
  }
}

Respond to a transfer request

post

Path parameters

idanyrequired

Header parameters

X-Fieldsanyoptional

An optional fields mask

Body

commentstringoptional

An optional comment about the transfer response

responsestring · enumrequired

The response

Example: acceptAvailable options:

Responses

application/json

objectoptional

post

HTTPcURLJavaScriptPython

POST /api/1/transfer/{id}/ HTTP/1.1
Host: www.data.gouv.fr
Content-Type: application/json
Accept: */*
Content-Length: 38

{
  "comment": "text",
  "response": "accept"
}

200

Success

{
  "comment": "text",
  "created": "2025-04-15T08:13:38.703Z",
  "id": "text",
  "owner": {
    "class": "text",
    "id": "text"
  },
  "recipient": {
    "class": "text",
    "id": "text"
  },
  "reponse_comment": "text",
  "responded": "2025-04-15T08:13:38.703Z",
  "status": "pending",
  "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"
  }
}