User Invitations

List pending user invitations

Returns active pending invitations for the authenticated caller's organization, sorted by email, with cursor pagination via after / before invitation ids.

get/v1/user_invitations

Request

  • Base URL
    https://identity-api.paymongo.com
  • URL
    https://identity-api.paymongo.com/v1/user_invitations
  • Auth
    none required

Query parameters

limitinteger

Page size (1-100, default 10)

afterstring

Invitation id — return page immediately after this anchor

beforestring

Invitation id — return page immediately before this anchor

Response

OK

has_moreboolean

Example response

{
  "data": [
    {
      "attributes": {
        "created_at": 1733097600,
        "email": "alice@example.com",
        "expires_at": 1735689600,
        "organization_id": "org_123",
        "organization_trade_name": "Hirthe and Sons",
        "roles": [
          "manage_users"
        ],
        "status": "pending",
        "token": "invt_xyz789",
        "updated_at": 1733097600
      }
    }
  ]
}

Changes

No recorded changes to this operation across all 1 revision of this API.