Skip to content
DashboardGet API key

List invitations

View .md
GET

List partner invitations for this project.

Authorization

  • Authorizationheaderrequired

    Bearer YOUR_API_KEY. Create a key in the dashboard.

Query parameters

  • statusstring

    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.

    One ofpendingin_progresscompletedexpiredcancelledfailed
  • limitinteger
    Default50
    Limitsmax 100
  • cursorstring

Responses

200List of invitations.
  • itemsobject[]required
    19 properties
    • idstringrequired
    • urlstringrequired

      Full URL to share with the client.

    • tokenstringrequired

      Unique invitation token.

    • clientNamestringnullable
    • clientEmailstringnullable
    • clientPhonestringnullable
    • phoneNumberIdstringnullable

      ID of a pre-assigned Zavu phone number for WhatsApp registration. Always null for messenger invitations.

    • connectionTypestring

      Which Meta channel the client connects: whatsapp_waba (official WhatsApp Cloud API via embedded signup) or messenger (a Facebook Page's Messenger inbox, including Marketplace chats).

      One ofwhatsapp_wabamessenger
    • statusstringrequired

      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.

      One ofpendingin_progresscompletedexpiredcancelledfailed
    • senderIdstringnullable

      ID of the sender created when invitation is completed.

    • connectedAccountobjectnullable

      The account the client linked, populated once the invitation is completed. Null before that. Use it to show the partner what was connected without fetching the sender.

      3 properties
      • channelstringrequired
        One ofwhatsappmessenger
      • idstringrequired

        Provider-side identifier: the WhatsApp phone number ID, or the Facebook Page ID.

      • namestringnullable

        Display name of the connected account: the WhatsApp verified name, or the Facebook Page name.

    • failureReasonstringnullable

      Stable code for why the last attempt failed, present when status is failed. Values include fb_cancelled (client closed Meta's dialog), fb_not_authorized (permission denied), signup_abandoned (started but never finished), meta_no_pages (the client administers no Facebook Page), and internal_error. Treat unknown codes as a generic failure.

    • failedAtstring<date-time>nullable
    • expiresAtstring<date-time>required
    • viewedAtstring<date-time>nullable
    • startedAtstring<date-time>nullable
    • completedAtstring<date-time>nullable
    • createdAtstring<date-time>required
    • updatedAtstring<date-time>required
  • nextCursorstringnullable
400Invalid query parameters (`invalid_request`): an unknown `status`, or `limit` outside 1-100.
  • codestringrequired
  • messagestringrequired
  • detailsobject
401Unauthorized.
  • codestringrequired
  • messagestringrequired
  • detailsobject