GET /lists/contacts

GET 
/lists/contacts

GET /lists/contacts

Request

Query Parameters

id int64[]
shopify_customer_id int64[]
stripe_customer_id string[]
woocommerce_customer_id int64[]
eshop_customer_id int64[]
reg_no string
tax_no string
vat_no string
business_name string
from int32
take int32
search string
sort string[]

Responses

200

OK

text/plain

Schema

Schema

total int64nullable
from int64nullable
take int64nullable

entities

object[]

nullable

Array [

id int64nullable

uid uuid

created_at date-timenullable

type stringrequired

Possible values: non-empty

Default value: COM

display_name stringrequired

Possible values: non-empty

business_name stringrequired

Possible values: non-empty

reg_no stringnullable

tax_no stringnullable

social_security_no stringnullable

currency stringnullable

payment_term int32nullable

email stringnullable

preferred_locale stringnullable

shopify_customer_id int64nullable

stripe_customer_id stringnullable

woocommerce_customer_id int64nullable

eshop_customer_id int64nullable

billing_address

object

id int64nullable

address1 stringnullable

address2 stringnullable

postal_code stringnullable

city stringnullable

country stringnullable

region stringnullable

subregion stringnullable

shipping_address

object

id int64nullable

address1 stringnullable

address2 stringnullable

postal_code stringnullable

city stringnullable

country stringnullable

region stringnullable

subregion stringnullable

taxes

object[]

nullable

Array [

country stringnullable

vat_no stringnullable

]

]

aggregations undefined[]nullable

Example (from schema)

{
  "total": 0,
  "from": 0,
  "take": 0,
  "entities": [
    {
      "id": 0,
      "uid": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
      "created_at": "2024-07-29T15:51:28.071Z",
      "type": "COM",
      "display_name": "string",
      "business_name": "string",
      "reg_no": "string",
      "tax_no": "string",
      "social_security_no": "string",
      "currency": "string",
      "payment_term": 0,
      "email": "string",
      "preferred_locale": "string",
      "shopify_customer_id": 0,
      "stripe_customer_id": "string",
      "woocommerce_customer_id": 0,
      "eshop_customer_id": 0,
      "billing_address": {
        "id": 0,
        "address1": "string",
        "address2": "string",
        "postal_code": "string",
        "city": "string",
        "country": "string",
        "region": "string",
        "subregion": "string"
      },
      "shipping_address": {
        "id": 0,
        "address1": "string",
        "address2": "string",
        "postal_code": "string",
        "city": "string",
        "country": "string",
        "region": "string",
        "subregion": "string"
      },
      "taxes": [
        {
          "country": "string",
          "vat_no": "string"
        }
      ]
    }
  ],
  "aggregations": [
    null
  ]
}

application/json

Schema

Schema

total int64nullable
from int64nullable
take int64nullable

entities

object[]

nullable

Array [

id int64nullable

uid uuid

created_at date-timenullable

type stringrequired

Possible values: non-empty

Default value: COM

display_name stringrequired

Possible values: non-empty

business_name stringrequired

Possible values: non-empty

reg_no stringnullable

tax_no stringnullable

social_security_no stringnullable

currency stringnullable

payment_term int32nullable

email stringnullable

preferred_locale stringnullable

shopify_customer_id int64nullable

stripe_customer_id stringnullable

woocommerce_customer_id int64nullable

eshop_customer_id int64nullable

billing_address

object

id int64nullable

address1 stringnullable

address2 stringnullable

postal_code stringnullable

city stringnullable

country stringnullable

region stringnullable

subregion stringnullable

shipping_address

object

id int64nullable

address1 stringnullable

address2 stringnullable

postal_code stringnullable

city stringnullable

country stringnullable

region stringnullable

subregion stringnullable

taxes

object[]

nullable

Array [

country stringnullable

vat_no stringnullable

]

]

aggregations undefined[]nullable

Example (from schema)

{
  "total": 0,
  "from": 0,
  "take": 0,
  "entities": [
    {
      "id": 0,
      "uid": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
      "created_at": "2024-07-29T15:51:28.071Z",
      "type": "COM",
      "display_name": "string",
      "business_name": "string",
      "reg_no": "string",
      "tax_no": "string",
      "social_security_no": "string",
      "currency": "string",
      "payment_term": 0,
      "email": "string",
      "preferred_locale": "string",
      "shopify_customer_id": 0,
      "stripe_customer_id": "string",
      "woocommerce_customer_id": 0,
      "eshop_customer_id": 0,
      "billing_address": {
        "id": 0,
        "address1": "string",
        "address2": "string",
        "postal_code": "string",
        "city": "string",
        "country": "string",
        "region": "string",
        "subregion": "string"
      },
      "shipping_address": {
        "id": 0,
        "address1": "string",
        "address2": "string",
        "postal_code": "string",
        "city": "string",
        "country": "string",
        "region": "string",
        "subregion": "string"
      },
      "taxes": [
        {
          "country": "string",
          "vat_no": "string"
        }
      ]
    }
  ],
  "aggregations": [
    null
  ]
}

text/json

Schema

Schema

total int64nullable
from int64nullable
take int64nullable

entities

object[]

nullable

Array [

id int64nullable

uid uuid

created_at date-timenullable

type stringrequired

Possible values: non-empty

Default value: COM

display_name stringrequired

Possible values: non-empty

business_name stringrequired

Possible values: non-empty

reg_no stringnullable

tax_no stringnullable

social_security_no stringnullable

currency stringnullable

payment_term int32nullable

email stringnullable

preferred_locale stringnullable

shopify_customer_id int64nullable

stripe_customer_id stringnullable

woocommerce_customer_id int64nullable

eshop_customer_id int64nullable

billing_address

object

id int64nullable

address1 stringnullable

address2 stringnullable

postal_code stringnullable

city stringnullable

country stringnullable

region stringnullable

subregion stringnullable

shipping_address

object

id int64nullable

address1 stringnullable

address2 stringnullable

postal_code stringnullable

city stringnullable

country stringnullable

region stringnullable

subregion stringnullable

taxes

object[]

nullable

Array [

country stringnullable

vat_no stringnullable

]

]

aggregations undefined[]nullable

Example (from schema)

{
  "total": 0,
  "from": 0,
  "take": 0,
  "entities": [
    {
      "id": 0,
      "uid": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
      "created_at": "2024-07-29T15:51:28.071Z",
      "type": "COM",
      "display_name": "string",
      "business_name": "string",
      "reg_no": "string",
      "tax_no": "string",
      "social_security_no": "string",
      "currency": "string",
      "payment_term": 0,
      "email": "string",
      "preferred_locale": "string",
      "shopify_customer_id": 0,
      "stripe_customer_id": "string",
      "woocommerce_customer_id": 0,
      "eshop_customer_id": 0,
      "billing_address": {
        "id": 0,
        "address1": "string",
        "address2": "string",
        "postal_code": "string",
        "city": "string",
        "country": "string",
        "region": "string",
        "subregion": "string"
      },
      "shipping_address": {
        "id": 0,
        "address1": "string",
        "address2": "string",
        "postal_code": "string",
        "city": "string",
        "country": "string",
        "region": "string",
        "subregion": "string"
      },
      "taxes": [
        {
          "country": "string",
          "vat_no": "string"
        }
      ]
    }
  ],
  "aggregations": [
    null
  ]
}

Loading...