getSafeDelegates
Returns the list of delegates for a given Safe address.
Usage
_13import { GetSafeDelegateProps } from '@safe-global/api-kit'_13import { apiKit } from './setup.ts'_13_13const config: GetSafeDelegateProps = {_13 safeAddress: '0x...', // Optional_13 delegateAddress: '0x...', // Optional_13 delegatorAddress: '0x...', // Optional_13 label: 'abc', // Optional_13 limit: '10', // Optional_13 offset: '50' // Optional_13}_13_13const delegates = await apiKit.getSafeDelegates(config)
Returns
Promise<SafeDelegateListResponse>
The list of delegates.
Parameters
config.safeAddress
(Optional)
- Type:
string
The Safe address.
_10const delegates = await apiKit.getSafeDelegates({_10 safeAddress: '0x...'_10})
config.delegateAddress
(Optional)
- Type:
string
The delegate address.
_10const delegates = await apiKit.getSafeDelegates({_10 delegateAddress: '0x...'_10})
config.delegatorAddress
(Optional)
- Type:
string
The delegator address.
_10const delegates = await apiKit.getSafeDelegates({_10 delegatorAddress: '0x...'_10})
config.label
(Optional)
- Type:
string
The custom label.
_10const delegates = await apiKit.getSafeDelegates({_10 label: 'abc'_10})
config.limit
(Optional)
- Type:
string
The number of results returned per page.
_10const delegates = await apiKit.getSafeDelegates({_10 limit: '10'_10})
config.offset
(Optional)
- Type:
string
The initial index from which to return the results.
_10const delegates = await apiKit.getSafeDelegates({_10 offset: '50'_10})