/getContactsPaginated

1 min

POST

Get contacts with server-side pagination and filtering.

Request Example:

from gk8_sdk.Helpers.ContactFilter import ContactFilter from gk8_sdk.Helpers.PaginatedContactRequest import PaginatedContactRequest from gk8_sdk.Helpers.Pagination import PageBasedPaginationInformation, SortOrder

contact_filter = ContactFilter( currencies=["ETH"], names=["alice"], sort_by="Name", sort_order=SortOrder.ASC, ) req = PaginatedContactRequest.create( pagination=PageBasedPaginationInformation(page_index=1, page_size=20), contact_filter=contact_filter, account_id=1, coin_symbol="ETH", specific_from_address="0x1234567890123456789012345678901234567890", ) getContactsPaginated(req)

Response Example:

{ "FunctionData": { "Machine": "MPC", "PageBasedPagination": { "PageIndex": 1, "PageSize": 100, "Attributes": { "FilterFields": { "ContactTypes": [ 3, 5, 6 ] }, "SortBy": [ { "Direction": "ASC", "Field": "Name" } ] }, "Meta": { "AccessToken": "58f08df6e369fa4d126e1ba5c7f66cf85c9c79df32d05fee8f3c542121c87cf5", "Destination": "044fd7dc60304b8aceeb662ce41bf9d9cc132278c0871c0a72fb4f3cecbabb25a86e43ae28dab21a95c64e2db76abdcfffb9bfdeec67a21399cfa5f555f01d054b", "Source": "be1f60e490b8ccabcc02a4595817b8edf45905d24944e87b8e3cae27f158df63843bfc4b09d37a5e752017b74ea2d136af272bea210f059e768e1ea8777aaf21e9", "Time": "2025-10-19 15:04

.129" } }

requeststringA PaginatedContactRequest object containing pagination params and filter criteria.

acceptstringGenerated from available response content types

200success

curl --request POST \
     --url '/getContactsPaginated?request=%0Acontact_filter%20%3D%20ContactFilter(%0Acurrencies%3D[%22ETH%22]%2C%0Anames%3D[%22alice%22]%2C%0Asort_by%3D%22Name%22%2C%0Asort_order%3DSortOrder.ASC%2C%0A)%0A%0Areq%20%3D%20PaginatedContactRequest.create(%0A%20%20%20%20pagination%3DPageBasedPaginationInformation(page_index%3D1%2C%20page_size%3D20)%2C%0A%20%20%20%20contact_filter%3Dcontact_filter%2C%0A%20%20%20%20account_id%3D1%2C%0A%20%20%20%20coin_symbol%3D%22ETH%22%2C%0A%20%20%20%20specific_from_address%3D%220x1234567890123456789012345678901234567890%22%2C%0A)%0AgetContactsPaginated(req)%22%0A' \
     --header 'accept: application/json'