Interface GetClaimsPayload

interface GetClaimsPayload {
    bookmark?: string;
    claimIds?: string[];
    fetchPrivateParams?: boolean;
    listId?: string;
    searchValue?: string;
    siwbbClaimsOnly?: boolean;
}

Properties

bookmark? claimIds? fetchPrivateParams? listId? searchValue? siwbbClaimsOnly?

Properties

Optionalbookmark

bookmark?: string

Bookmark to start from. Obtained from previours request. Leave blank to start from the beginning. Only applicable when no additional criteria is specified.

OptionalclaimIds

claimIds?: string[]

The claim IDs to fetch.

OptionalfetchPrivateParams

fetchPrivateParams?: boolean

Fetch private parameters for the claim. Only applicable if you are the creator / manager of the claim.

OptionallistId

listId?: string

If the address list is private and viewable with the link only, you must also specify the address list ID to prove knowledge of the link.

OptionalsearchValue

searchValue?: string

If provided, we will only return claims with names that match the search value. Only applicable for fetching your own claims.

OptionalsiwbbClaimsOnly

siwbbClaimsOnly?: boolean

If true, we will return all claims that were created by the signed in address.

Settings

Member Visibility

On This Page

Properties