Available methods

getBusinessAccountGifts()

Returns the gifts received and owned by a managed business account. Requires the can_view_gifts_and_stars business bot right. Returns OwnedGifts on success.

parameters

parametertyperequireddescription
business_connection_idstringrequiredUnique identifier of the business connection
exclude_unsavedbooleanoptionalPass True to exclude gifts that aren't saved to the account's profile page
exclude_savedbooleanoptionalPass True to exclude gifts that are saved to the account's profile page
exclude_unlimitedbooleanoptionalPass True to exclude gifts that can be purchased an unlimited number of times
exclude_limited_upgradablebooleanoptionalPass True to exclude gifts that can be purchased a limited number of times and can be upgraded to unique
exclude_limited_non_upgradablebooleanoptionalPass True to exclude gifts that can be purchased a limited number of times and can't be upgraded to unique
exclude_uniquebooleanoptionalPass True to exclude unique gifts
exclude_from_blockchainbooleanoptionalPass True to exclude gifts that were assigned from the TON blockchain and can't be resold or transferred in Telegram
sort_by_pricebooleanoptionalPass True to sort results by gift price instead of send date. Sorting is applied before pagination.
offsetstringoptionalOffset of the first entry to return as received from the previous request; use empty string to get the first chunk of results
limitnumberoptionalThe maximum number of gifts to be returned; 1-100. Defaults to 100.

returns

OwnedGifts

usage in yaebal

not (yet) hard-typed on Api — call it through the generic .call<T>() escape hatch documented in @yaebal/types.

bot.ts
import type { GetBusinessAccountGiftsParams, OwnedGifts } from "@yaebal/types";

await bot.api.call<OwnedGifts>("getBusinessAccountGifts", {
  business_connection_id: "...",
} satisfies GetBusinessAccountGiftsParams);