NAnatural
Invitations

List party invitations

Changed on

List party invitations

get/party-invitations

Request

  • Base URL
    https://api.natural.com
  • URL
    https://api.natural.com/party-invitations
  • Auth
    HTTP bearer

Query parameters

limitinteger

Maximum results per page.

cursorstring

Cursor from the previous page.

partyIdstring

Party to filter by; only your own party is accepted.

emailstring

Filter by email.

status'PENDING' | 'ACCEPTED' | 'REVOKED' | 'DECLINED'

Filter by status.

Headers

X-Instance-IDstring nullable

Caller-chosen identifier for the agent run, session, or conversation, required when an agent moves money.

Response

Successful Response

Changes

  • bbac797fe7f1Revision changes
    • info

      added the new optional query request parameter cursor

    • info

      added the new optional query request parameter limit

  • c7c12da5915fRevision changes
    • 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

      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

      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

      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