Get a list of contacts mail.recipient.listcontacts

curl -X POST \
        -H "Content-Type: application/json" \
        -H "Accept: application/json" \
        -d '{"query":"client","pagination":{"page":1,"limit":20,"offset":0},"auth":"**put_access_token_here**"}' \
        https://**put_your_bitrix24_address**/rest/api/mail.recipient.listcontacts
        

// This snippet is an ES module: top-level await requires type="module" or a bundler.
        // $b24 is an already-initialized SDK instance (see the SDK "Get started" guide).
        import { Text } from '@bitrix24/b24jssdk'
        import type { B24Frame } from '@bitrix24/b24jssdk'
        
        declare const $b24: B24Frame
        
        // Shape of the payload returned in result (match the "response handling" section of the page)
        type ListContactsResult = {
          items: {
            id: number
            email: string
            name: string
          }[]
        }
        
        try {
          const response = await $b24.actions.v3.call.make<ListContactsResult>({
            method: 'mail.recipient.listcontacts',
            params: {
              query: 'client',
              pagination: {
                page: 1,
                limit: 20,
                offset: 0,
              },
            },
            requestId: Text.getUuidRfc4122()
          })
        
          // The payload is available only on a successful response
          if (!response.isSuccess) {
            console.error(response.getErrorMessages().join('; '))
          } else {
            const result = response.getData()!.result
            console.info('Contacts:', result.items)
          }
        } catch (error) {
          // Thrown on transport or SDK failures (AjaxError, SdkError, etc.)
          console.error(error)
        }
        

<!-- Load the SDK (UMD build); it is exposed as the global B24Js -->
        <script src="https://unpkg.com/@bitrix24/b24jssdk@1/dist/umd/index.min.js"></script>
        <script>
          async function listContacts() {
            try {
              // Initialize the SDK inside a Bitrix24 frame
              const $b24 = await B24Js.initializeB24Frame()
        
              const response = await $b24.actions.v3.call.make({
                method: 'mail.recipient.listcontacts',
                params: {
                  query: 'client',
                  pagination: {
                    page: 1,
                    limit: 20,
                    offset: 0,
                  },
                },
                requestId: B24Js.Text.getUuidRfc4122()
              })
        
              // The payload is available only on a successful response
              if (!response.isSuccess) {
                console.error(response.getErrorMessages().join('; '))
                return
              }
        
              const result = response.getData().result
              console.info('Contacts:', result.items)
            } catch (error) {
              // Thrown on transport or SDK failures (AjaxError, SdkError, etc.)
              console.error(error)
            }
          }
        
          document.addEventListener('DOMContentLoaded', listContacts)
        </script>
        

from b24pysdk.errors import BitrixAPIError, BitrixSDKException
        
        pagination = {
            "page": 1,
            "limit": 20,
            "offset": 0,
        }
        
        try:
            bitrix_response = client.mail.recipient.listcontacts(
                query='client',
                pagination=pagination,
            ).response
            result = bitrix_response.result
            print(result)
        except BitrixAPIError as error:
            print(
                "Bitrix API error",
                f"error: {error.error}",
                f"error_description: {error.error_description}",
                sep="\n",
            )
        except BitrixSDKException as error:
            print(f"Bitrix SDK error: {error.message}")
        except Exception as error:
            print(f"Unexpected error: {error}")
        

try {
            $response = $b24Service
                ->core
                ->call(
                    'mail.recipient.listcontacts',
                    [
                        'query' => 'client',
                        'pagination' => [
                            'page' => 1,
                            'limit' => 20,
                            'offset' => 0
                        ]
                    ]
                );
        
            $result = $response
                ->getResponseData()
                ->getResult();
        
            echo 'Success: ' . print_r($result, true);
        
        } catch (Throwable $e) {
            error_log($e->getMessage());
            echo 'Error: ' . $e->getMessage();
        }
        

BX24.callMethod(
            'mail.recipient.listcontacts',
            {
                query: 'client',
                pagination: {
                    page: 1,
                    limit: 20,
                    offset: 0
                }
            },
            function(result){
                console.info(result.data());
                console.log(result);
            }
        );
        

require_once('crest.php');
        
        $result = CRest::call(
            'mail.recipient.listcontacts',
            [
                'query' => 'client',
                'pagination' => [
                    'page' => 1,
                    'limit' => 20,
                    'offset' => 0
                ]
            ]
        );
        
        echo '<PRE>';
        print_r($result);
        echo '</PRE>';
        

// client and ctx are already created — see the Go SDK section
        res, err := client.Core().Call(ctx, "mail.recipient.listcontacts", b24.Params{
        	"query": "client",
        	"pagination": b24.Params{
        		"page":   1,
        		"limit":  20,
        		"offset": 0,
        	},
        })
        if err != nil {
        	return fmt.Errorf("mail.recipient.listcontacts: %w", err)
        }
        
        // The method wraps the response in an object with the "items" key.
        raw, ok := b24.Unwrap(res.Result, "items")
        if !ok {
        	return fmt.Errorf("no items key in the response")
        }
        
        var items []struct {
        	ID    b24.ID `json:"id"`
        	Email string `json:"email"`
        	Name  string `json:"name"`
        }
        if err := json.Unmarshal(raw, &items); err != nil {
        	return fmt.Errorf("parse response: %w", err)
        }
        for _, it := range items {
        	fmt.Println(it.ID)
        }