Light APIv1.0.0

API / Reference / Customers

List customers

GET https://api.light.inc/v1/customers

Returns a paginated list of customers

Authorization

Send one of these on every request. See Authentication for how to get credentials.

  • API key

    Basic authentication header of the form Basic <api_key>, where <api_key> is your api key.

  • Bearer token

Query parameters

  • sort string

    Sort string in the format field:direction. To provide multiple sort fields, separate them with commas.

    Available directions: asc, desc.

    Available fields: name, email, createdAt, updatedAt.

  • filter string

    Filter string in the format field:operator:value. To provide multiple filters, separate them with commas.

    Available operators: eq, ne, in, not_in, gt, gte, lt, lte.

    • For in and not_in operators, provide multiple values separated by the pipe character (|).

    Available fields: billingAddressCity, billingAddressCountry, businessRegistrationNumber, createdAt, description, email, externalSourceId, externalSourceName, id, name, status, updatedAt, vatNumber.

    These fields accept only a subset of the operators: externalSourceId (eq, in), externalSourceName (eq, in).

  • searchTerm string

    Search term to filter results by. Performs a case-insensitive partial match across searchable fields.

  • limit integer · int32

    Maximum number of items to return. Default is 50, maximum is 200.

  • offset integer · int64deprecated

    Number of items to skip before starting to collect the result set. Deprecated, use 'cursor' instead.

  • cursor string

    The cursor position to start returning results from. To opt-in into cursor-based pagination, provide 0 for the initial request. For subsequent requests, use nextCursor and prevCursor from the previous response to navigate. Cursor values are opaque and should not be constructed manually.

Response

  • records array of object

    List of records for the current page

    • id string · uuid

      Unique identifier for the object

    • name string

      Name of the customer

    • email string

      Email address of the customer

    • address object

      • country string

        ⚠️ This enum is not exhaustive; new values may be added in the future.

        One of UNDEFINED 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 BU BV BW BY BZ CA CC CD CF CG CH CI CK CL CM CN CO CP CR CS CU CV CW CX CY CZ DE DG DJ DK DM DO DZ EA EC EE EG EH ER ES ET EU EZ FI FJ FK FM FO FR FX 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 NT 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 SF SG SH SI SJ SK SL SM SN SO SR SS ST SU SV SX SY SZ TA TC TD TF TG TH TJ TK TL TM TN TO TP TR TT TV TW TZ UA UG UK UM US UY UZ VA VC VE VG VI VN VU WF WS XI XU XK YE YT YU ZA ZM ZR ZW

      • city string

      • state string

      • zipcode string

      • street string

      • street2 string

    • billingAddress object

      • country string

        ⚠️ This enum is not exhaustive; new values may be added in the future.

        One of UNDEFINED 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 BU BV BW BY BZ CA CC CD CF CG CH CI CK CL CM CN CO CP CR CS CU CV CW CX CY CZ DE DG DJ DK DM DO DZ EA EC EE EG EH ER ES ET EU EZ FI FJ FK FM FO FR FX 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 NT 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 SF SG SH SI SJ SK SL SM SN SO SR SS ST SU SV SX SY SZ TA TC TD TF TG TH TJ TK TL TM TN TO TP TR TT TV TW TZ UA UG UK UM US UY UZ VA VC VE VG VI VN VU WF WS XI XU XK YE YT YU ZA ZM ZR ZW

      • city string

      • state string

      • zipcode string

      • street string

      • street2 string

    • shippingAddress object

      • country string

        ⚠️ This enum is not exhaustive; new values may be added in the future.

        One of UNDEFINED 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 BU BV BW BY BZ CA CC CD CF CG CH CI CK CL CM CN CO CP CR CS CU CV CW CX CY CZ DE DG DJ DK DM DO DZ EA EC EE EG EH ER ES ET EU EZ FI FJ FK FM FO FR FX 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 NT 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 SF SG SH SI SJ SK SL SM SN SO SR SS ST SU SV SX SY SZ TA TC TD TF TG TH TJ TK TL TM TN TO TP TR TT TV TW TZ UA UG UK UM US UY UZ VA VC VE VG VI VN VU WF WS XI XU XK YE YT YU ZA ZM ZR ZW

      • city string

      • state string

      • zipcode string

      • street string

      • street2 string

    • status string

      Current status of the customer

      • ACTIVE - The customer is active and can be used in invoices and contracts
      • ARCHIVED - The customer is archived and cannot be used in new invoices or contracts

      ⚠️ This enum is not exhaustive; new values may be added in the future.

      One of ACTIVE ARCHIVED

    • description string

      Description or notes about the customer

    • vatNumber string

      VAT number of the customer

    • businessRegistrationNumber string

      Business registration number of the customer

    • easCode string

      Electronic Address Scheme code used for sending e-invoices

    • einvoiceAddress string

      E-invoice address for the customer

    • einvoiceNetwork string

      E-invoice network the customer is registered on

      • FR_PA - France Plateforme Agréée (Chorus Pro / Annuaire) e-invoice network
      • MYDATA - Greece myDATA e-invoice network
      • NEMHANDEL - NemHandel e-invoice network
      • PEPPOL - Peppol e-invoice network
      • PORTUGUESE_TAX_REPORTING - Portuguese tax reporting (ATCUD) e-invoice network
      • SDI - SDI (Sistema di Interscambio) e-invoice network
      • VERIFACTU - Spain VERI*FACTU tax reporting e-invoice network

      ⚠️ This enum is not exhaustive; new values may be added in the future.

      One of FR_PA MYDATA NEMHANDEL PEPPOL PORTUGUESE_TAX_REPORTING SDI VERIFACTU

    • type string

      Type of customer

      • BUSINESS - Business customer
      • CONSUMER - Consumer customer
      • GOVERNMENT - Government customer

      ⚠️ This enum is not exhaustive; new values may be added in the future.

      One of BUSINESS CONSUMER GOVERNMENT

    • logoUrl string

      URL to the customer's logo

    • domain string

      Domain of the customer's website

    • externalSource object

      The external system where this product was synced from

      • name string

        The name of the external source

        • CHARGEBEE - Data synced from Chargebee
        • HUBSPOT - Data synced from HubSpot
        • SALESFORCE - Data synced from Salesforce
        • STRIPE - Data synced from Stripe

        ⚠️ This enum is not exhaustive; new values may be added in the future.

        One of CHARGEBEE HUBSPOT SALESFORCE STRIPE

      • externalId string

        The ID of the object in the external source system

    • createdAt string · date-time

      Timestamp when the customer was created

    • updatedAt string · date-time

      Timestamp when the customer was last updated

    • customProperties array of object

      List of custom properties associated with the customer

      • groupId string · uuid

        ID of the custom property group

      • groupInternalName string

        Internal name of the custom property group

      • values array of object

        List of values. Note that this will be a single value unless the group input type supports multiple values

        • id string · uuid

          Unique identifier for the object

        • groupId string · uuid

          ID of the custom property group

        • groupInternalName string

          Internal name of the custom property group

        • companyId string · uuid

          ID of the company

        • internalName string

          Internal name of the custom property value

        • label string

          Label of the custom property value

        • context string

          Context/description of the custom property value

        • createdAt string · date-time

          Timestamp when the custom property value was created

        • updatedAt string · date-time

          Timestamp when the custom property value was last updated

    • recipientEmails array of string

      Billing email recipients ("Send to") used when sending invoices to this customer

    • ccEmails array of string

      Billing email CC recipients used when sending invoices to this customer

  • hasMore boolean

    Boolean flag indicating if there are more records available

  • total integer · int64deprecated

    Total number of records (only for offset pagination). This field is not guaranteed to be returned and only available for offset pagination, please do not rely on it and migrate to cursor pagination.

  • nextCursor string

    Cursor for fetching the next page (only for cursor pagination)

  • prevCursor string

    Cursor for fetching the previous page (only for cursor pagination)