--- title: "Search Contacts" method: GET path: "/business/v2/contacts" tags: ["Contacts"] --- # Search Contacts `GET /business/v2/contacts` ## Request - Base URL: `https://api.soldo.com` - URL: `https://api.soldo.com/business/v2/contacts` - Auth: OAuth 2 - Client credentials - Token URL: `https://api.soldo.com/oauth/authorize` scopes: `contact_read` - TypeScript: (a function with typed inputs; its response is checked against the schema) Endpoint to search `Contacts` using filtering parameters. ## Query parameters - `statuses` ContactStatus[]: The status to search `Contacts` by. Multiple values are allowed. If omitted, `Contacts` in both `CREATED` and `SUGGESTED` status are returned. - `name` string[]: The name to search `Contacts` by. Multiple values are allowed. - `type` ContactType[]: The type to search `Contacts` by. Multiple values are allowed. - `countries` ISO3166Country[]: The [ISO 3166-1 alpha-3](https://www.iso.org/obp/ui/#search/code/) code of the country to search `Contacts` by. Multiple values are allowed. - `user` string[]: The ID of the `User` the `Contact` is assigned to, to search `Contacts` by (only `Contacts` of type `EMPLOYEE` are assigned to a `User`). Multiple values are allowed. - `p` integer: It indicates the specific page to display (the counter starts from zero). - `s` integer: It indicates the number of items per page. - `d` 'ASC' | 'DESC': It indicates how the pages are ordered. - `props` string[]: It indicates the sorting direction applied to the above parameters. To apply a sorting on multiple parameters, set as many times the `props` parameter in the request. ## Response `200` The returned result is a list of `Contacts`. - Contacts - `total` integer: It represents the total number of available items in the list. - `pages` integer: It represents the total number of available pages. - `page_size` integer: It represents the number of items per page. - `current_page` integer: It indicates the current page (the counter starts from zero). - `results_size` integer: It indicates the size of the array results. - `results` Contact[] - `id` string: The `Contact` ID. - `name` string: The name of the `Contact`. - `user_id` string: The ID of the `User` the `Contact` is assigned to (only for `Contacts` of type `EMPLOYEE`). - `type` 'SUPPLIER' | 'CLIENT' | 'EMPLOYEE' | 'ACCOUNT' - `payment_scheme` PaymentSchema[]: The payment schemes that can be used to pay the `Contact`. - `account_info` AccountInfoContact[]: The bank account details of the `Contact`. - `type` 'SORT_CODE' | 'ACCOUNT_NUMBER' | 'IBAN' - `identification` string: The value of the bank account identifier. `IBAN`: a valid IBAN. `ACCOUNT_NUMBER`: exactly 8 digits (pad shorter account numbers with leading zeros). `SORT_CODE`: 6 digits, with or without dashes (e.g. `123456` or `12-34-56`); it is stored and returned in the `12-34-56` format. - `bic` string: The BIC (SWIFT code) of the bank of the `Contact`, if provided. - `country` 'ASC' | 'AND' | 'ARE' | 'AFG' | 'ATG' | 'AIA' | 'ALB' | 'ARM' | 'ANT' | 'AGO' | 'ATA' | 'ARG' | 'ASM' | 'AUT' | 'AUS' | 'ABW' | 'ALA' | 'AZE' | 'BIH' | 'BRB' | 'BGD' | 'BEL' | 'BFA' | 'BGR' | 'BHR' | 'BDI' | 'BEN' | 'BLM' | 'BMU' | 'BRN' | 'BOL' | 'BES' | 'BRA' | 'BHS' | 'BTN' | 'BUR' | 'BVT' | 'BWA' | 'BLR' | 'BLZ' | 'CAN' | 'CCK' | 'COD' | 'CAF' | 'COG' | 'CHE' | 'CIV' | 'COK' | 'CHL' | 'CMR' | 'CHN' | 'COL' | 'CPT' | 'CRI' | 'CSXX' | 'CUB' | 'CPV' | 'CUW' | 'CXR' | 'CYP' | 'CZE' | 'DEU' | 'DGA' | 'DJI' | 'DNK' | 'DMA' | 'DOM' | 'DZA' | 'ECU' | 'EST' | 'EGY' | 'ESH' | 'ERI' | 'ESP' | 'ETH' | 'FIN' | 'FJI' | 'FLK' | 'FSM' | 'FRO' | 'FRA' | 'FXX' | 'GAB' | 'GBR' | 'GRD' | 'GEO' | 'GUF' | 'GGY' | 'GHA' | 'GIB' | 'GRL' | 'GMB' | 'GIN' | 'GLP' | 'GNQ' | 'GRC' | 'SGS' | 'GTM' | 'GUM' | 'GNB' | 'GUY' | 'HKG' | 'HMD' | 'HND' | 'HRV' | 'HTI' | 'HUN' | 'IDN' | 'IRL' | 'ISR' | 'IMN' | 'IND' | 'IOT' | 'IRQ' | 'IRN' | 'ISL' | 'ITA' | 'JEY' | 'JAM' | 'JOR' | 'JPN' | 'KEN' | 'KGZ' | 'KHM' | 'KIR' | 'COM' | 'KNA' | 'PRK' | 'KOR' | 'KWT' | 'CYM' | 'KAZ' | 'LAO' | 'LBN' | 'LCA' | 'LIE' | 'LKA' | 'LBR' | 'LSO' | 'LTU' | 'LUX' | 'LVA' | 'LBY' | 'MAR' | 'MCO' | 'MDA' | 'MNE' | 'MAF' | 'MDG' | 'MHL' | 'MKD' | 'MLI' | 'MMR' | 'MNG' | 'MAC' | 'MNP' | 'MTQ' | 'MRT' | 'MSR' | 'MLT' | 'MUS' | 'MDV' | 'MWI' | 'MEX' | 'MYS' | 'MOZ' | 'NAM' | 'NCL' | 'NER' | 'NFK' | 'NGA' | 'NIC' | 'NLD' | 'NOR' | 'NPL' | 'NRU' | 'NTZ' | 'NIU' | 'NZL' | 'OMN' | 'PAN' | 'PER' | 'PYF' | 'PNG' | 'PHL' | 'PAK' | 'POL' | 'SPM' | 'PCN' | 'PRI' | 'PSE' | 'PRT' | 'PLW' | 'PRY' | 'QAT' | 'REU' | 'ROU' | 'ROM' | 'SRB' | 'RUS' | 'RWA' | 'SAU' | 'SLB' | 'SYC' | 'SDN' | 'SWE' | 'SGP' | 'SHN' | 'SVN' | 'SJM' | 'SVK' | 'SLE' | 'SMR' | 'SEN' | 'SOM' | 'SUR' | 'SSD' | 'STP' | 'SUN' | 'SLV' | 'SXM' | 'SYR' | 'SWZ' | 'TAA' | 'TCA' | 'TCD' | 'ATF' | 'TGO' | 'THA' | 'TJK' | 'TKL' | 'TLS' | 'TKM' | 'TUN' | 'TON' | 'TUR' | 'TTO' | 'TUV' | 'TWN' | 'TZA' | 'UKR' | 'UGA' | 'UMI' | 'USA' | 'URY' | 'UZB' | 'VAT' | 'VCT' | 'VEN' | 'VGB' | 'VIR' | 'VNM' | 'VUT' | 'WLF' | 'WSM' | 'XKX' | 'XXK' | 'QZZ' | 'YEM' | 'MYT' | 'YUCS' | 'ZAF' | 'ZMB' | 'ZRCD' | 'ZWE' - `status` 'CREATED' | 'SUGGESTED' - `creation_time` string: The date and time when the `Contact` was created. - `last_update_time` string: The date and time when the `Contact` was last updated. - `bank_account_verification_status` 'UNABLE_TO_MATCH' | 'FULL_MATCH' | 'PARTIAL_MATCH' | 'NO_MATCH' | 'UNABLE_TO_VERIFY' - `validation` ContactSuggestion - `field` string: The field of the `Contact` the check refers to (currently always `name`). Returned only when the bank provides a `suggested_value`. - `current_value` string: The `name` provided for the `Contact`. Returned only when the bank provides a `suggested_value`. - `suggested_value` string: The account holder name registered by the bank, which can be used to correct the `name` of the `Contact`. - `match_status` 'UNABLE_TO_MATCH' | 'FULL_MATCH' | 'PARTIAL_MATCH' | 'NO_MATCH' | 'UNABLE_TO_VERIFY' ## Other responses - `400`: Your request has missing arguments or is malformed. ## Changes - **2026-11-10** `23fc5d07b367`: 1 info - added the optional property `results/items/validation` to the response with the `200` status - **2026-08-06** `7be21448a2b3`: 1 warning, 3 info - added the new `QZZ` enum value to the `results/items/country` response property for the response status `200` - added the enum value `QZZ` to the property `items/` of the `query` request parameter `countries` - added the optional property `results/items/bank_account_verification_status` to the response with the `200` status - added the optional property `results/items/bic` to the response with the `200` status [Operation history](https://skmtc.dev/soldo/apis/soldo-business-api-v2-0/changes/business/v2/contacts/get.md) --- [API](https://skmtc.dev/soldo/apis/soldo-business-api-v2-0.md) - [All operations](https://skmtc.dev/soldo/apis/soldo-business-api-v2-0/llms.txt) - [OpenAPI document](https://skmtc.dev/soldo/apis/soldo-business-api-v2-0/revisions/23fc5d07b367?raw)