List invitations

Changed on

List partner invitations for this project.

get/v1/invitations

Request

  • Base URL
    https://api.zavu.dev
  • URL
    https://api.zavu.dev/v1/invitations
  • Auth
    HTTP bearer

Query parameters

status'pending' | 'in_progress' | 'completed' | 'expired' | 'cancelled' | 'failed'

Current status of the partner invitation.

failed means the client started the connection and it did not finish (they cancelled Meta's dialog, denied a permission, or abandoned the tab). A failed invitation is still usable: the same link can be retried, and it moves back to in_progress when the client tries again.

limitinteger
cursorstring

Response

List of invitations.

nextCursorstring nullable

Example response

{
  "items": [
    {
      "id": "inv_abc123",
      "url": "https://dashboard.zavu.dev/invite/abc123xyz"
    }
  ]
}

Changes

    • warning

      added the new failed enum value to the // response property for the response status

    • warning

      added the new messenger enum value to the // response property for the response status

    • info

      added the new enum value failed to the query request parameter status

    • info

      added the optional property // to the response with the status

    • info

      added the optional property // to the response with the status

    • info

      added the optional property // to the response with the status

    • info

      removed the whatsapp_alt enum value from the // response property for the response status