Sign in
Manage projects and library content

List of invites

Invites sent or received by current user about transferring project ownership.

List can be filtered with mode parameter, e.g.: display only received invites.

Possible values for mode:

  • sender
  • recipient
get/api/v2/project-ownership/invites/

Request

  • The document declares no server URL.
  • Auth: one of:
    • HTTP basic
    • API key in header Authorization

Query parameters

limitinteger

Number of results to return per page. Use with start.

modestring
offsetinteger

Deprecated alias of start.

startinteger

The initial index from which to return the results. Use with limit.

Response

countinteger required
nextstring uri nullable
previousstring uri nullable

Example response

{
  "count": 123,
  "next": "https://kf.kobotoolbox.org/api-endpoint/?start=400&limit=100",
  "previous": "https://kf.kobotoolbox.org/api-endpoint/?start=200&limit=100",
  "results": [
    {
      "url": "https://kf.kobotoolbox.org/api/v2/project-ownership/invites/poi52fGkwDjQeZkUxcaou39q/",
      "sender |  recipient": "https://kf.kobotoolbox.org/api/v2/users/bob/",
      "transfers": [
        {
          "url": "https://kf.kobotoolbox.org/api/v2/project-ownership/invites/poi52fGkwDjQeZkUxcaou39q/transfers/pot54pTqM5qwKdZ4wnNdiwDY/",
          "asset": "https://kf.kobotoolbox.org/api/v2/assets/a3C9wWefqZVkChNLKqqXVZ/"
        }
      ]
    }
  ]
}

Changes

No recorded changes to this operation across all 50 revisions of this API.