> ## Documentation Index > Fetch the complete documentation index at: https://integrations.docs.commenda.io/llms.txt > Use this file to discover all available pages before exploring further. # List contacts ## OpenAPI ````yaml /openapi_v4_core.json get /v4/core/companies/{companyId}/contacts openapi: 3.0.0 info: title: Commenda Integrations V4 API description: Commenda Integrations — unified accounting, commerce, and CRM API. version: 4.0.0 contact: {} servers: - url: https://api.integrations.commenda.io description: Production security: - api_key: [] tags: [] paths: /v4/core/companies/{companyId}/contacts: get: tags: - Accounting - Payments - E-Commerce - CRM summary: List contacts operationId: list_contacts parameters: - name: companyId in: path required: true description: Commenda company id. schema: type: integer - name: limit in: query required: false description: Max records to return. schema: type: integer default: 20 maximum: 100 - name: next in: query required: false description: Cursor for the next page (from a previous response). schema: type: string - name: prev in: query required: false description: Cursor for the previous page. schema: type: string - name: include_deleted_records in: query required: false description: Include soft-deleted records. schema: type: boolean - name: return_count in: query required: false description: Include the total match count in the response. schema: type: boolean - name: expand in: query required: false description: >- Comma-separated related resources to expand: addresses, phone_numbers, external_links. schema: type: string - name: type[eq] in: query required: false description: Exact match on type. schema: type: string enum: - CUSTOMER - VENDOR - BOTH - UNKNOWN - name: type[in] in: query required: false description: Comma-separated type values (OR match). schema: type: string - name: status[eq] in: query required: false description: Exact match on status. schema: type: string enum: - ACTIVE - INACTIVE - SUSPENDED - ARCHIVED - UNKNOWN - name: status[in] in: query required: false description: Comma-separated status values (OR match). schema: type: string - name: name[eq] in: query required: false description: Exact match on name. schema: type: string - name: name[in] in: query required: false description: Comma-separated name values (OR match). schema: type: string - name: email[eq] in: query required: false description: Exact match on email. schema: type: string - name: email[in] in: query required: false description: Comma-separated email values (OR match). schema: type: string - name: phone[eq] in: query required: false description: Exact match on phone. schema: type: string - name: phone[in] in: query required: false description: Comma-separated phone values (OR match). schema: type: string - name: rootfi_integration_type[eq] in: query required: false description: Exact match on rootfi_integration_type. schema: type: string - name: rootfi_integration_type[in] in: query required: false description: Comma-separated rootfi_integration_type values (OR match). schema: type: string - name: rootfi_updated_at[eq] in: query required: false description: Exact match on rootfi_updated_at. schema: type: string - name: rootfi_updated_at[in] in: query required: false description: Comma-separated rootfi_updated_at values (OR match). schema: type: string - name: rootfi_updated_at[gte] in: query required: false description: rootfi_updated_at greater-than-or-equal. schema: type: string - name: rootfi_updated_at[lte] in: query required: false description: rootfi_updated_at less-than-or-equal. schema: type: string - name: created_at[eq] in: query required: false description: Exact match on created_at. schema: type: string - name: created_at[in] in: query required: false description: Comma-separated created_at values (OR match). schema: type: string - name: created_at[gte] in: query required: false description: created_at greater-than-or-equal. schema: type: string - name: created_at[lte] in: query required: false description: created_at less-than-or-equal. schema: type: string - name: updated_at[eq] in: query required: false description: Exact match on updated_at. schema: type: string - name: updated_at[in] in: query required: false description: Comma-separated updated_at values (OR match). schema: type: string - name: updated_at[gte] in: query required: false description: updated_at greater-than-or-equal. schema: type: string - name: updated_at[lte] in: query required: false description: updated_at less-than-or-equal. schema: type: string responses: '200': description: A paginated list of contacts. content: application/json: schema: type: object properties: data: type: object properties: data: type: array items: $ref: '#/components/schemas/Contact' total_count: type: integer next: type: string nullable: true prev: type: string nullable: true required: - data - total_count - next - prev request_id: type: string required: - data - request_id components: schemas: Contact: type: object properties: rootfi_id: type: integer description: Unique identifier assigned by Commenda for this contact rootfi_created_at: type: string format: date-time description: >- Timestamp when this record was created in Commenda's system (ISO 8601) rootfi_updated_at: type: string format: date-time description: >- Timestamp when this record was last updated in Commenda's system (ISO 8601) rootfi_integration_type: type: string enum: - BUSY - CLEARBOOKS - FREEAGENT - FRESHBOOKS - KASHFLOW - MEKARI_JURNAL - MS_DYNAMICS_365 - MS_DYNAMICS_365_FO - MYOB_BUSINESS - NETSUITE - ODOO_ACCOUNTING - QOYOD - QUICKBOOKS - QUICKBOOKS_SANDBOX - ROOTFI_SANDBOX - SAGE_CLOUD_ACCOUNTING - SAGE_ZA_CLOUD_ACCOUNTING - SAGE_INTACCT - TALLY - WAFEQ - WAVE - XERO - ZOHO_BOOKS - PUZZLE_SANDBOX - PUZZLE - RILLET - RILLET_SANDBOX - AMAZON - BIG_COMMERCE - SHOPIFY - SQUARESPACE - WIX - WOO_COMMERCE - GOOGLE_PLAYSTORE - CHARGEBEE - MOLLIE - PAYPAL - PAYPAL_SANDBOX - RAZORPAY - SQUARE - SQUARE_SANDBOX - STRIPE - STRIPE_TEST - STRIPE_SANDBOX - ZOHO_INVOICE - PADDLE - PADDLE_SANDBOX - HUBSPOT - PIPEDRIVE - SALES_FORCE - ZOHO_CRM - GUSTO platform_id: type: string description: Unique identifier for this contact in the source accounting platform name: type: string nullable: true description: The name of the contact contact_name: type: string nullable: true description: The name of the contact person for the contact email: type: string nullable: true phone: type: string nullable: true tax_number: type: string nullable: true description: The contact's tax number type: type: string enum: - CUSTOMER - VENDOR - BOTH - UNKNOWN nullable: true description: The type of contact status: type: string enum: - ACTIVE - INACTIVE - SUSPENDED - ARCHIVED - UNKNOWN nullable: true description: The status of the contact currency_id: type: string enum: - AED - AFN - ALL - AMD - ANG - AOA - ARS - AUD - AWG - AZN - BAM - BBD - BDT - BGN - BHD - BIF - BMD - BND - BOB - BOV - BRL - BSD - BTN - BWP - BYN - BZD - CAD - CDF - CHE - CHF - CHW - CLF - CLP - CNY - COP - COU - CRC - CUC - CUP - CVE - CZK - DJF - DKK - DOP - DZD - EGP - ERN - ETB - EUR - FJD - FKP - GBP - GEL - GHS - GIP - GMD - GNF - GTQ - GYD - HKD - HNL - HTG - HUF - IDR - ILS - INR - IQD - IRR - ISK - JMD - JOD - JPY - KES - KGS - KHR - KMF - KPW - KRW - KWD - KYD - KZT - LAK - LBP - LKR - LRD - LSL - LYD - MAD - MDL - MGA - MKD - MMK - MNT - MOP - MRU - MUR - MVR - MWK - MXN - MXV - MYR - MZN - NAD - NGN - NIO - NOK - NPR - NZD - OMR - PAB - PEN - PGK - PHP - PKR - PLN - PYG - QAR - RON - RSD - RUB - RWF - SAR - SBD - SCR - SDG - SEK - SGD - SHP - SLE - SOS - SRD - SSP - STN - SVC - SYP - SZL - THB - TJS - TMT - TND - TOP - TRY - TTD - TWD - TZS - UAH - UGX - USD - USN - UYI - UYU - UYW - UZS - VED - VES - VND - VUV - WST - XAF - XAG - XAU - XBA - XBB - XBC - XBD - XCD - XDR - XOF - XPD - XPF - XPT - XSU - XTS - XUA - XXX - YER - ZAR - ZMW - ZWG nullable: true description: The ISO-4217 currency code of the contact registration_number: type: string nullable: true description: The contact's identifying or registration number website: type: string nullable: true created_at: type: string format: date-time nullable: true updated_at: type: string format: date-time nullable: true description: The date and time the contact was last updated addresses: type: array items: $ref: '#/components/schemas/Address' nullable: true phone_numbers: type: array items: $ref: '#/components/schemas/PhoneNumber' nullable: true external_links: type: array items: $ref: '#/components/schemas/ExternalLink' nullable: true required: - rootfi_id - rootfi_created_at - rootfi_updated_at - rootfi_integration_type - platform_id description: >- A contact is an individual or company that buys or sells goods or services from a business. Commonly referred to as a customer on a corresponding invoice or a vendor for a bill. Address: type: object properties: rootfi_id: type: integer rootfi_created_at: type: string format: date-time rootfi_updated_at: type: string format: date-time rootfi_integration_type: type: string enum: - BUSY - CLEARBOOKS - FREEAGENT - FRESHBOOKS - KASHFLOW - MEKARI_JURNAL - MS_DYNAMICS_365 - MS_DYNAMICS_365_FO - MYOB_BUSINESS - NETSUITE - ODOO_ACCOUNTING - QOYOD - QUICKBOOKS - QUICKBOOKS_SANDBOX - ROOTFI_SANDBOX - SAGE_CLOUD_ACCOUNTING - SAGE_ZA_CLOUD_ACCOUNTING - SAGE_INTACCT - TALLY - WAFEQ - WAVE - XERO - ZOHO_BOOKS - PUZZLE_SANDBOX - PUZZLE - RILLET - RILLET_SANDBOX - AMAZON - BIG_COMMERCE - SHOPIFY - SQUARESPACE - WIX - WOO_COMMERCE - GOOGLE_PLAYSTORE - CHARGEBEE - MOLLIE - PAYPAL - PAYPAL_SANDBOX - RAZORPAY - SQUARE - SQUARE_SANDBOX - STRIPE - STRIPE_TEST - STRIPE_SANDBOX - ZOHO_INVOICE - PADDLE - PADDLE_SANDBOX - HUBSPOT - PIPEDRIVE - SALES_FORCE - ZOHO_CRM - GUSTO platform_id: type: string parent_id: type: string nullable: true parent_type: type: string enum: - ACCOUNT - BALANCE_SHEET - BANK_ACCOUNT - BANK_TRANSACTION - BILL - BILL_CREDIT_NOTE - BILL_PAYMENT - CASH_FLOW_STATEMENT - COMPANY_INFO - CONTACT - CURRENCY - DOCUMENT - EXPENSE - GOODS_RECEIPT_NOTE - INCOME_STATEMENT - INVOICE - INVOICE_CREDIT_NOTE - INVOICE_PAYMENT - ITEM - JOURNAL_ENTRY - JOURNAL_LINE - PROJECT - PURCHASE_ORDER - SALES_ORDER - ESTIMATE - TAX_RATE - TRACKING_CATEGORY - CASH_SALE - CASH_REFUND - BALANCE - DISPUTE - ORDER - PAYOUT - SUBSCRIPTION - TRANSACTION - EVENT - FULFILLMENT - INVENTORY - COMPANY - LEAD - OPPORTUNITY - PIPELINE - PIPELINE_STAGE - NOTE - TASK - OWNER - ENGAGEMENT - ADDRESS - EXTERNAL_LINK - LINE_ITEM - PHONE_NUMBER - VARIANT nullable: true type: type: string enum: - SHIPPING - BILLING - COMPANY - WAREHOUSE nullable: true street: type: string nullable: true street2: type: string nullable: true locality: type: string nullable: true city: type: string nullable: true state: type: string nullable: true postal_code: type: string nullable: true country: type: string nullable: true required: - rootfi_id - rootfi_created_at - rootfi_updated_at - rootfi_integration_type - platform_id PhoneNumber: type: object properties: rootfi_id: type: integer rootfi_created_at: type: string format: date-time rootfi_updated_at: type: string format: date-time rootfi_integration_type: type: string enum: - BUSY - CLEARBOOKS - FREEAGENT - FRESHBOOKS - KASHFLOW - MEKARI_JURNAL - MS_DYNAMICS_365 - MS_DYNAMICS_365_FO - MYOB_BUSINESS - NETSUITE - ODOO_ACCOUNTING - QOYOD - QUICKBOOKS - QUICKBOOKS_SANDBOX - ROOTFI_SANDBOX - SAGE_CLOUD_ACCOUNTING - SAGE_ZA_CLOUD_ACCOUNTING - SAGE_INTACCT - TALLY - WAFEQ - WAVE - XERO - ZOHO_BOOKS - PUZZLE_SANDBOX - PUZZLE - RILLET - RILLET_SANDBOX - AMAZON - BIG_COMMERCE - SHOPIFY - SQUARESPACE - WIX - WOO_COMMERCE - GOOGLE_PLAYSTORE - CHARGEBEE - MOLLIE - PAYPAL - PAYPAL_SANDBOX - RAZORPAY - SQUARE - SQUARE_SANDBOX - STRIPE - STRIPE_TEST - STRIPE_SANDBOX - ZOHO_INVOICE - PADDLE - PADDLE_SANDBOX - HUBSPOT - PIPEDRIVE - SALES_FORCE - ZOHO_CRM - GUSTO platform_id: type: string parent_id: type: string nullable: true parent_type: type: string enum: - ACCOUNT - BALANCE_SHEET - BANK_ACCOUNT - BANK_TRANSACTION - BILL - BILL_CREDIT_NOTE - BILL_PAYMENT - CASH_FLOW_STATEMENT - COMPANY_INFO - CONTACT - CURRENCY - DOCUMENT - EXPENSE - GOODS_RECEIPT_NOTE - INCOME_STATEMENT - INVOICE - INVOICE_CREDIT_NOTE - INVOICE_PAYMENT - ITEM - JOURNAL_ENTRY - JOURNAL_LINE - PROJECT - PURCHASE_ORDER - SALES_ORDER - ESTIMATE - TAX_RATE - TRACKING_CATEGORY - CASH_SALE - CASH_REFUND - BALANCE - DISPUTE - ORDER - PAYOUT - SUBSCRIPTION - TRANSACTION - EVENT - FULFILLMENT - INVENTORY - COMPANY - LEAD - OPPORTUNITY - PIPELINE - PIPELINE_STAGE - NOTE - TASK - OWNER - ENGAGEMENT - ADDRESS - EXTERNAL_LINK - LINE_ITEM - PHONE_NUMBER - VARIANT nullable: true number: type: string nullable: true type: type: string enum: - MOBILE - TELEPHONE - FAX nullable: true required: - rootfi_id - rootfi_created_at - rootfi_updated_at - rootfi_integration_type - platform_id ExternalLink: type: object properties: rootfi_id: type: integer rootfi_created_at: type: string format: date-time rootfi_updated_at: type: string format: date-time rootfi_integration_type: type: string enum: - BUSY - CLEARBOOKS - FREEAGENT - FRESHBOOKS - KASHFLOW - MEKARI_JURNAL - MS_DYNAMICS_365 - MS_DYNAMICS_365_FO - MYOB_BUSINESS - NETSUITE - ODOO_ACCOUNTING - QOYOD - QUICKBOOKS - QUICKBOOKS_SANDBOX - ROOTFI_SANDBOX - SAGE_CLOUD_ACCOUNTING - SAGE_ZA_CLOUD_ACCOUNTING - SAGE_INTACCT - TALLY - WAFEQ - WAVE - XERO - ZOHO_BOOKS - PUZZLE_SANDBOX - PUZZLE - RILLET - RILLET_SANDBOX - AMAZON - BIG_COMMERCE - SHOPIFY - SQUARESPACE - WIX - WOO_COMMERCE - GOOGLE_PLAYSTORE - CHARGEBEE - MOLLIE - PAYPAL - PAYPAL_SANDBOX - RAZORPAY - SQUARE - SQUARE_SANDBOX - STRIPE - STRIPE_TEST - STRIPE_SANDBOX - ZOHO_INVOICE - PADDLE - PADDLE_SANDBOX - HUBSPOT - PIPEDRIVE - SALES_FORCE - ZOHO_CRM - GUSTO platform_id: type: string parent_id: type: string nullable: true parent_type: type: string enum: - ACCOUNT - BALANCE_SHEET - BANK_ACCOUNT - BANK_TRANSACTION - BILL - BILL_CREDIT_NOTE - BILL_PAYMENT - CASH_FLOW_STATEMENT - COMPANY_INFO - CONTACT - CURRENCY - DOCUMENT - EXPENSE - GOODS_RECEIPT_NOTE - INCOME_STATEMENT - INVOICE - INVOICE_CREDIT_NOTE - INVOICE_PAYMENT - ITEM - JOURNAL_ENTRY - JOURNAL_LINE - PROJECT - PURCHASE_ORDER - SALES_ORDER - ESTIMATE - TAX_RATE - TRACKING_CATEGORY - CASH_SALE - CASH_REFUND - BALANCE - DISPUTE - ORDER - PAYOUT - SUBSCRIPTION - TRANSACTION - EVENT - FULFILLMENT - INVENTORY - COMPANY - LEAD - OPPORTUNITY - PIPELINE - PIPELINE_STAGE - NOTE - TASK - OWNER - ENGAGEMENT - ADDRESS - EXTERNAL_LINK - LINE_ITEM - PHONE_NUMBER - VARIANT nullable: true link: type: string nullable: true type: type: string enum: - WEBSITE - EMAIL nullable: true required: - rootfi_id - rootfi_created_at - rootfi_updated_at - rootfi_integration_type - platform_id securitySchemes: api_key: type: apiKey in: header name: api_key description: Your Commenda Integrations API key, sent in the `api_key` header. ````