Function getNotifications

  • Retrieve notifications matching the query.

    Parameters

    • query: {
          limit?: number;
          page?: number;
          read?: boolean;
          resourceType?: string;
          sort?: "+createdAt" | "-createdAt" | "+updatedAt" | "-updatedAt";
      }

      an object with query parameters

      • Optionallimit?: number

        The number of notification entries to retrieved.

      • Optionalpage?: number

        Page number

      • Optionalread?: boolean

        Read status of the notification

      • OptionalresourceType?: string

        Filter by resource types. If passing more than 1 resource type, use comma seperated string.

      • Optionalsort?: "+createdAt" | "-createdAt" | "+updatedAt" | "-updatedAt"

        The field to sort by, with +/- prefix indicating sort order

    • Optionaloptions: ApiCallOptions

    Returns Promise<GetNotificationsHttpResponse>

    getNotifications(
    {
    resourceType: "app,space"
    }
    )

    GetNotificationsHttpError