st.retrieveInvitations

This action retrieves all incoming invitations currently shown in the LinkedIn invitation manager.

Constraints

⏺️ Root Start: allowed.

⬆️ Parent Actions: N/A.

⬇️ Child Actions: N/A.

Parameters

json
{
  "actionType": "st.retrieveInvitations",
  "label": "invitations1"
}
  • label (optional) – custom label for tracking this action in workflow completion.
  • then is not supported.

Result options

This action always completes successfully. If there are no incoming invitations, it returns an empty array.

json
{
  "actionType": "st.retrieveInvitations",
  "label": "invitations1",
  "success": true,
  "data": [
    {
      "invitationType": "connect",
      "name": "John Doe",
      "publicUrl": "https://www.linkedin.com/in/johndoe",
      "headline": "Founder & CEO at Example Company",
      "note": "I would like to connect."
    },
    {
      "invitationType": "companyFollow",
      "name": "Jane Smith",
      "publicUrl": "https://www.linkedin.com/in/janesmith",
      "companyUrl": "https://www.linkedin.com/company/example-company",
      "companyName": "Example Company"
    },
    {
      "invitationType": "newsletterSubscribe",
      "name": "Carlos Santos",
      "publicUrl": "https://www.linkedin.com/in/carlossantos",
      "newsletterUrl": "https://www.linkedin.com/newsletters/example-1234567890",
      "newsletterName": "Example Newsletter"
    }
  ]
}

Every item contains:

  • invitationTypeconnect, companyFollow, or newsletterSubscribe.
  • name – name of the person who sent the invitation.
  • publicUrlpublic LinkedIn URL of that person.

Type-specific fields:

  • connect: headline and note (each can be null).
  • companyFollow: companyUrl and companyName (companyName can be null).
  • newsletterSubscribe: newsletterUrl and newsletterName (newsletterName can be null).