Skip to main content
POST
Check Invitation Status

Overview

Returns the current connection / invitation status with a specific user. Useful to know whether you’re already connected, have a pending sent or received invitation, or have no relationship yet.
This endpoint consumes 1 credit per request. Ignore this if you’re on per-seat pricing: usage is unlimited.

Request

string
required
Your API key for authentication.
string
required
The unique identifier of the account to use.
string
required
Must be "check_invitation".
object
required

Response

boolean
Indicates whether the request was successful.
object
object