PApaymongo
User Invitations

Get a user invitation by token (public)

Returns the invitation corresponding to the token in the URL path. Used by the accept-invitation flow.

get/v1/user_invitations/{id}

Request

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

Path parameters

idstring required

Invitation token

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.