--- title: "GET /party" method: GET path: "/party" tags: ["party"] --- # GET /party `GET /party` ## Request - Base URL: `https://www.weclapp.com/api/nullapi/v2` - URL: `https://www.weclapp.com/api/nullapi/v2/party` - Auth: API key in header `AuthenticationToken` - TypeScript: (a function with typed inputs; its response is checked against the schema) query party ## Query parameters - `page` integer - `pageSize` integer - `sort` string - `additionalProperties` string ## Response `200` party response - object - `result` Party[] - `id` string - `version` string - `addresses` Address[] - `id` string - `version` string - `city` string - `company` string - `company2` string - `countryCode` 'AC' | 'AD' | 'AE' | 'AF' | 'AG' | 'AI' | 'AL' | 'AM' | 'AN' | 'AO' | 'AQ' | 'AR' | 'AS' | 'AT' | 'AU' | 'AW' | 'AX' | 'AZ' | 'BA' | 'BB' | 'BD' | 'BE' | 'BF' | 'BG' | 'BH' | 'BI' | 'BJ' | 'BL' | 'BM' | 'BN' | 'BO' | 'BQ' | 'BR' | 'BS' | 'BT' | 'BV' | 'BW' | 'BY' | 'BZ' | 'CA' | 'CC' | 'CD' | 'CF' | 'CG' | 'CH' | 'CI' | 'CK' | 'CL' | 'CM' | 'CN' | 'CO' | 'CR' | 'CS' | 'CU' | 'CV' | 'CW' | 'CX' | 'CY' | 'CZ' | 'DE' | 'DG' | 'DJ' | 'DK' | 'DM' | 'DO' | 'DZ' | 'EA' | 'EC' | 'EE' | 'EG' | 'EH' | 'ER' | 'ES' | 'ET' | 'EU' | 'FI' | 'FJ' | 'FK' | 'FM' | 'FO' | 'FR' | 'GA' | 'GB' | 'GD' | 'GE' | 'GF' | 'GG' | 'GH' | 'GI' | 'GL' | 'GM' | 'GN' | 'GP' | 'GQ' | 'GR' | 'GS' | 'GT' | 'GU' | 'GW' | 'GY' | 'HK' | 'HM' | 'HN' | 'HR' | 'HT' | 'HU' | 'IC' | 'ID' | 'IE' | 'IL' | 'IM' | 'IN' | 'IO' | 'IQ' | 'IR' | 'IS' | 'IT' | 'JE' | 'JM' | 'JO' | 'JP' | 'KE' | 'KG' | 'KH' | 'KI' | 'KM' | 'KN' | 'KP' | 'KR' | 'KW' | 'KY' | 'KZ' | 'LA' | 'LB' | 'LC' | 'LI' | 'LK' | 'LR' | 'LS' | 'LT' | 'LU' | 'LV' | 'LY' | 'MA' | 'MC' | 'MD' | 'ME' | 'MF' | 'MG' | 'MH' | 'MK' | 'ML' | 'MM' | 'MN' | 'MO' | 'MP' | 'MQ' | 'MR' | 'MS' | 'MT' | 'MU' | 'MV' | 'MW' | 'MX' | 'MY' | 'MZ' | 'NA' | 'NC' | 'NE' | 'NF' | 'NG' | 'NI' | 'NL' | 'NO' | 'NP' | 'NR' | 'NU' | 'NZ' | 'OM' | 'PA' | 'PE' | 'PF' | 'PG' | 'PH' | 'PK' | 'PL' | 'PM' | 'PN' | 'PR' | 'PS' | 'PT' | 'PW' | 'PY' | 'QA' | 'RE' | 'RO' | 'RS' | 'RU' | 'RW' | 'SA' | 'SB' | 'SC' | 'SD' | 'SE' | 'SG' | 'SH' | 'SI' | 'SJ' | 'SK' | 'SL' | 'SM' | 'SN' | 'SO' | 'SR' | 'SS' | 'ST' | 'SV' | 'SX' | 'SY' | 'SZ' | 'TA' | 'TC' | 'TD' | 'TF' | 'TG' | 'TH' | 'TJ' | 'TK' | 'TL' | 'TM' | 'TN' | 'TO' | 'TR' | 'TT' | 'TV' | 'TW' | 'TZ' | 'UA' | 'UG' | 'UM' | 'UNKNOWN' | 'US' | 'UY' | 'UZ' | 'VA' | 'VC' | 'VE' | 'VG' | 'VI' | 'VN' | 'VU' | 'WF' | 'WS' | 'XI' | 'XK' | 'YE' | 'YT' | 'ZA' | 'ZM' | 'ZW', required - `createdDate` integer - `deliveryAddress` boolean - `firstName` string - `globalLocationNumber` string - `invoiceAddress` boolean - `lastModifiedDate` integer - `lastName` string - `phoneNumber` string - `postOfficeBoxCity` string - `postOfficeBoxNumber` string - `postOfficeBoxZipCode` string - `primaryAddress` boolean - `salutation` 'COMPANY' | 'FAMILY' | 'MR' | 'MRS' | 'NO_SALUTATION' - `state` string - `street1` string - `street2` string - `titleId` string - `zipcode` string - `bankAccounts` PartyBankAccount[] - `id` string - `version` string - `accountHolder` string - `accountNumber` string, required - `bankCode` string, required - `createdDate` integer - `creditInstitute` string - `lastModifiedDate` integer - `partyId` string, required - `primary` boolean - `birthDate` integer - `commercialLanguageId` string - `commissionBlock` boolean - `commissionSalesPartners` CommissionSalesPartner[] - `id` string - `version` string - `commissionFix` string, number - `commissionPercentage` string, number - `commissionType` 'FIX' | 'FIX_AND_MARGIN' | 'FIX_AND_REVENUE' | 'MARGIN' | 'NO_COMMISSION' | 'REVENUE', required - `createdDate` integer - `lastModifiedDate` integer - `salesPartnerSupplierId` string, required - `company` string - `company2` string - `companySizeId` string - `competitor` boolean - `contacts` OnlyId[] - `id` string - `convertedOnDate` integer - `createdDate` integer - `currencyId` string - `customAttributes` CustomAttribute[] - `attributeDefinitionId` string - `booleanValue` boolean - `dateValue` integer - `entityId` string - `entityReferences` EntityReference[] - `entityId` string - `entityName` string - `numberValue` string, number - `selectedValueId` string - `selectedValues` OnlyId[] - `id` string - `stringValue` string - `customer` boolean - `customerActive` boolean - `customerAllowDropshippingOrderCreation` boolean - `customerAmountInsured` string, number - `customerAnnualRevenue` string, number - `customerBlockNotice` string - `customerBlocked` boolean - `customerBusinessType` 'B2B' | 'B2C' | 'B2G' - `customerCategoryId` string - `customerCreditLimit` string, number - `customerCurrentSalesStageId` string - `customerDebtorAccountId` string - `customerDebtorAccountingCodeId` string - `customerDefaultHeaderDiscount` string, number - `customerDefaultHeaderSurcharge` string, number - `customerDefaultShippingCarrierId` string - `customerDefaultWarehouseId` string - `customerDeliveryBlock` boolean - `customerInsolvent` boolean - `customerInsured` boolean - `customerInternalNote` string - `customerLossDescription` string - `customerLossReasonId` string - `customerNonStandardTaxId` string - `customerNumber` string - `customerNumberOld` string - `customerPaymentMethodId` string - `customerSalesChannel` string - `customerSalesOrderPaymentType` 'ADVANCE_PAYMENT' | 'COUNTER_SALES' | 'PART_PAYMENT' | 'PREPAYMENT' | 'STANDARD' - `customerSalesProbability` integer - `customerSalesStageHistory` SalesStageHistory[] - `id` string - `version` string - `createdDate` integer - `lastModifiedDate` integer - `salesStageId` string - `userId` string - `customerSatisfaction` 'NEUTRAL' | 'SATISFIED' | 'UNSATISFIED' - `customerShipmentMethodId` string - `customerSupplierNumber` string - `customerTermOfPaymentId` string - `customerUseCustomsTariffNumber` boolean - `deliveryAddressId` string - `deliveryEmailAddressesId` string - `description` string - `dunningAddressId` string - `dunningEmailAddressesId` string - `email` string - `emailHome` string - `enableDropshippingInNewSupplySources` boolean - `eoriNumber` string - `factoring` boolean - `fax` string - `firstName` string - `fixPhone2` string - `fixedResponsibleUser` boolean - `formerSalesPartner` boolean - `habitualExporter` boolean - `imageId` string - `invoiceAddressId` string - `invoiceBlock` boolean - `invoiceRecipientId` string - `lastModifiedDate` integer - `lastName` string - `leadRatingId` string - `leadSourceId` string - `leadStatus` 'CONVERTED' | 'DISQUALIFIED' | 'NEW' | 'PREQUALIFIED' | 'QUALIFIED' - `legalFormId` string - `middleName` string - `mobilePhone1` string - `mobilePhone2` string - `onlineAccounts` OnlineAccount[] - `id` string - `version` string - `accountName` string - `accountType` 'AMAZON' | 'BLOG' | 'EBAY' | 'FACEBOOK' | 'GOOGLE_DRIVE' | 'INSTAGRAM' | 'LINKEDIN' | 'OTHER' | 'PINTEREST' | 'SKYPE' | 'SLIDESHARE' | 'TWITTER' | 'WIKIPEDIA' | 'XING' | 'YELP' | 'YOUTUBE' - `createdDate` integer - `lastModifiedDate` integer - `url` string - `optInEmail` boolean - `optInLetter` boolean - `optInPhone` boolean - `optInSms` boolean - `parentPartyId` string - `partyEmailAddresses` PartyEmailAddresses[] - `id` string - `version` string - `bccAddresses` string - `ccAddresses` string - `createdDate` integer - `lastModifiedDate` integer - `toAddresses` string - `partyHabitualExporterLettersOfIntent` PartyHabitualExporterLetterOfIntent[] - `id` string - `version` string - `automaticallySuggestInInvoice` boolean - `createdDate` integer - `date` integer, required - `fromSupplier` boolean - `invoices` OnlyId[] - `id` string - `lastModifiedDate` integer - `numberDeclarer` string, required - `numberSupplier` string - `totalAmount` string, number - `type` 'MULTIPLE_ACCOUNTING_EVENTS' | 'SINGLE_ACCOUNTING_EVENT', required - `partyType` 'ORGANIZATION' | 'PERSON', required - `personCompany` string - `personDepartmentId` string - `personRoleId` string - `phone` string - `phoneHome` string - `primaryAddressId` string - `primaryContactId` string - `publicPageExpirationDate` integer - `publicPageUuid` string - `purchaseEmailAddressesId` string - `purchaseViaPlafond` boolean - `quotationEmailAddressesId` string - `ratingId` string - `referenceNumber` string - `regionId` string - `responsibleUserId` string - `salesInvoiceEmailAddressesId` string - `salesOrderEmailAddressesId` string - `salesPartner` boolean - `salesPartnerDefaultCommissionFix` string, number - `salesPartnerDefaultCommissionPercentage` string, number - `salesPartnerDefaultCommissionType` 'FIX' | 'FIX_AND_MARGIN' | 'FIX_AND_REVENUE' | 'MARGIN' | 'NO_COMMISSION' | 'REVENUE' - `salutation` 'COMPANY' | 'FAMILY' | 'MR' | 'MRS' | 'NO_SALUTATION' - `sectorId` string - `supplier` boolean - `supplierActive` boolean - `supplierCreditorAccountId` string - `supplierCreditorAccountingCodeId` string - `supplierCustomerNumberAtSupplier` string - `supplierDefaultShippingCarrierId` string - `supplierInternalNote` string - `supplierMergeItemsForOcrInvoiceUpload` boolean - `supplierMinimumPurchaseOrderAmount` string, number - `supplierNonStandardTaxId` string - `supplierNumber` string - `supplierNumberOld` string - `supplierOrderBlock` boolean - `supplierPaymentMethodId` string - `supplierShipmentMethodId` string - `supplierTermOfPaymentId` string - `tags` string[] - `taxId` string - `titleId` string - `topics` OnlyId[] - `id` string - `vatIdentificationNumber` string - `website` string - `xRechnungLeitwegId` string - `additionalProperties` object - `customerChildrenSalesOrderVolumeCurrentYear` string[] - `customerChildrenSalesOrderVolumePreviousYear` string[] - `customerChildrenSalesRevenueCurrentYear` string[] - `customerChildrenSalesRevenuePreviousYear` string[] - `customerQuotationAcceptancePercentage` string[] - `customerQuotationAcceptanceTimeInDays` integer[] - `customerReturnPercentageCurrentYear` string[] - `customerReturnPercentagePreviousYear` string[] - `customerSalesOpenItemOverdueSum` string[] - `customerSalesOpenItemSum` string[] - `customerSalesOrderVolumeCurrentYear` string[] - `customerSalesOrderVolumePreviousYear` string[] - `customerSalesRevenueCurrentYear` string[] - `customerSalesRevenuePreviousYear` string[] - `leadChildrenExpectedRevenueOpportunities` string[] - `leadChildrenExpectedRevenueQuotations` string[] - `leadChildrenQuotationVolume` string[] - `leadExpectedRevenueOpportunities` string[] - `leadExpectedRevenueQuotations` string[] - `leadQuotationVolume` string[] - `supplierChildrenPurchaseOrderVolumeCurrentYear` string[] - `supplierChildrenPurchaseOrderVolumePreviousYear` string[] - `supplierChildrenPurchaseRevenueCurrentYear` string[] - `supplierChildrenPurchaseRevenuePreviousYear` string[] - `supplierPurchaseOrderVolumeCurrentYear` string[] - `supplierPurchaseOrderVolumePreviousYear` string[] - `supplierPurchaseRevenueCurrentYear` string[] - `supplierPurchaseRevenuePreviousYear` string[] ## Other responses - `default`: error response ## Changes - **2026-11-07** `0e021229755d`: 1 info - added the new optional `query` request parameter `additionalProperties` [Operation history](https://skmtc.dev/weclapp/apis/weclapp-api/changes/party/get.md) --- [API](https://skmtc.dev/weclapp/apis/weclapp-api.md) - [All operations](https://skmtc.dev/weclapp/apis/weclapp-api/llms.txt) - [OpenAPI document](https://skmtc.dev/weclapp/apis/weclapp-api/revisions/0e021229755d?raw)