Get the list of pending user invitations

Opigno Enterprise API provides an endpoint to get the list of pending user invitations. To retrieve this list, getPendingUserInvitations query should be called. The query returns the list of invitations that have been sent to the current user (fetched from the request) and are not accepted yet. The data contains pagination and sorting options. Supports cursor-based pagination (after, before) or limit-based (first, last). The same pagination approach as in other queries is used (for example, getCatalogData). The following arguments can be used in the query:

Argument	Type	Description	Default
`after`	`Cursor`	Returns results that come after the specified cursor. Should be used together with `first` parameter. Cannot be used if `before` is set.	—
`before`	`Cursor`	Returns results that come before the specified cursor. Should be used together with `last` parameter. Cannot be used if `after` is set.	—
`first`	`Integer`	Returns up to the first N elements from the list. Required if `after` parameter is set. Cannot be used together with `last`.	—
`last`	`Integer`	Returns up to the first N elements from the list. Required if `before` parameter is set. Cannot be used together with `first`.	—
`reverse`	`Boolean`	Allows to change the order of the sorting to `DESC`.	`false`
`sortKey`	`InvitationSortKey`	Provides the possibility to change the query sorting key. Available options: `CREATED` (sorting by the creation date) or `NAME` (by the initiator user context name).	`CREATED`

  query getPendingUserInvitations {
    getPendingUserInvitations(first: 1) {
      edges {
        node {
          initiatorUserContext {
            id
            uuid
          }
          cta {
            actionId
            title
            arguments {
              key
              value
            }
            metadata {
              key
              value
            }
          }
        }
      }
      pageInfo {
        hasNextPage
        startCursor
        endCursor
      }
      totalItems
    }
  }

  {
    "data": {
      "getPendingUserInvitations": {
        "edges": [
          {
            "node": {
              "initiatorUserContext": {
                "id": "3468",
                "uuid": "6c3b1455-c183-46f6-aa59-44f82dda0331",
              },
              "cta": [
                {
                  "actionId": "ACCEPT_USER_INVITATION",
                  "title": "Accept",
                  "arguments": [
                    {
                      "key": "invitationId",
                      "value": "60"
                    }
                  ],
                  "metadata": [
                    {
                      "key": "type",
                      "value": "button"
                    }
                  ]
                },
                {
                  "actionId": "DECLINE_USER_INVITATION",
                  "title": "Decline",
                  "arguments": [
                    {
                      "key": "invitationId",
                      "value": "60"
                    }
                  ],
                  "metadata": [
                    {
                      "key": "type",
                      "value": "button"
                    }
                  ]
                }
              ]
            }
          },
        ],
        "pageInfo": {
          "hasNextPage": false,
          "startCursor": "TzozMzoiRHJ1cGFsXG9waWdub19hcGlcV3JhcHBlcnNcQ3Vyc29yIjo0OntzOjE0OiIAKgBiYWNraW5nVHlwZSI7czoyMjoib3BpZ25vX3VzZXJfY29ubmVjdGlvbiI7czoxMjoiACoAYmFja2luZ0lkIjtpOjYwO3M6MTA6IgAqAHNvcnRLZXkiO3M6NzoiQ1JFQVRFRCI7czoxMjoiACoAc29ydFZhbHVlIjtpOjE3NTE2MzI4MjQ7fQ==",
          "endCursor": "TzozMzoiRHJ1cGFsXG9waWdub19hcGlcV3JhcHBlcnNcQ3Vyc29yIjo0OntzOjE0OiIAKgBiYWNraW5nVHlwZSI7czoyMjoib3BpZ25vX3VzZXJfY29ubmVjdGlvbiI7czoxMjoiACoAYmFja2luZ0lkIjtpOjYwO3M6MTA6IgAqAHNvcnRLZXkiO3M6NzoiQ1JFQVRFRCI7czoxMjoiACoAc29ydFZhbHVlIjtpOjE3NTE2MzI4MjQ7fQ=="
        },
        "totalItems": 1
      }
    }
  }

The list of nodes in the response contains UserInvatation object, the full example can be found here.

Getting started

Integration & Concepts

Use cases

Hierarchy Management

Zapier Integration

Mobile application

Get the list of pending user invitations