Get a list of all customers | Solvimon

curl https://test.api.solvimon.com/v1/customers \
     -H "X-API-KEY: <apiKey>"

{
  "data": [
    {
      "reference": "string",
      "type": "ORGANIZATION",
      "email": "string",
      "roles": [
        "DEFAULT"
      ],
      "object_type": "string",
      "id": "string",
      "created_at": "string",
      "parent_customer_id": "string",
      "parent_customer_ids": [
        "string"
      ],
      "status": "DRAFT",
      "timezone": "string",
      "notification_preferences": [
        {
          "type": "INVOICE",
          "channels": [
            {
              "type": "EMAIL",
              "enabled": true
            }
          ]
        }
      ],
      "locale": "string",
      "individual": {
        "name": {
          "first_name": "string",
          "last_name": "string",
          "infix": "string"
        },
        "residential_address": {
          "line1": "string",
          "line2": "string",
          "city": "string",
          "postal_code": "string",
          "state": "string",
          "country": "AD"
        }
      },
      "organization": {
        "legal_name": "string",
        "tax_id": "string",
        "tax_ids": [
          {
            "id": "string",
            "type": "GENERIC_TAX_ID",
            "tax_id_validation_result": {
              "id": "string",
              "validation_date": "string",
              "source": "string",
              "valid": "VALID",
              "message": "string"
            }
          }
        ],
        "registration_number": "string",
        "tax_exempt": true,
        "tax_exempt_note": "string",
        "registered_address": {
          "line1": "string",
          "line2": "string",
          "city": "string",
          "postal_code": "string",
          "state": "string",
          "country": "AD"
        },
        "tax_registrations": [
          {
            "id": "string",
            "description": "string",
            "tax_id": "string",
            "tax_ids": [
              {
                "id": "string",
                "type": "GENERIC_TAX_ID",
                "tax_id_validation_result": {
                  "id": "string",
                  "validation_date": "string",
                  "source": "string",
                  "valid": "VALID",
                  "message": "string"
                }
              }
            ],
            "registration_number": "string",
            "registered_address": {
              "line1": "string",
              "line2": "string",
              "city": "string",
              "postal_code": "string",
              "state": "string",
              "country": "AD"
            }
          }
        ]
      },
      "custom_fields": [
        {
          "id": "string",
          "reference": "string",
          "value": "string",
          "values": [
            "string"
          ],
          "integration_details": {
            "payment_gateway_variant": "ADYEN",
            "id": "string",
            "reference": "string",
            "adyen": {
              "recurring_detail_reference": "string"
            },
            "stripe": {
              "payment_method_id": "string"
            }
          }
        }
      ],
      "processing_only": true,
      "pricing_plan_subscription_selector": {
        "data": [
          {
            "field": "BILLING_ENTITY_REGISTERED_ADDRESS_COUNTRY",
            "value": "string"
          }
        ],
        "rules": [
          {
            "field": "BILLING_ENTITY_REGISTERED_ADDRESS_COUNTRY",
            "type": "EQUALS"
          }
        ],
        "filters": [
          {
            "field": "BILLING_ENTITY_REGISTERED_ADDRESS_COUNTRY",
            "type": "EQUALS",
            "value": "string"
          }
        ],
        "fallback": "LATEST"
      },
      "linked_integrations": [
        {
          "id": "string",
          "link_details": [
            {
              "url": "string",
              "custom_field_name": "string"
            }
          ]
        }
      ]
    }
  ],
  "page": 1,
  "limit": 1,
  "links": {
    "first": "string",
    "previous": "string",
    "current": "string",
    "next": "string"
  },
  "total_number_of_pages": 1
}

Requires the CUSTOMER.VIEW permission.

Authentication

X-API-KEYstring

API Key authentication via header

AuthorizationBearer

Bearer authentication of the form Bearer <token>, where token is your auth token.

Path parameters

versionstringRequiredDefaults to 1

version

Query parameters

limitintegerOptional

The amount of records shown in the list

pageintegerOptional

The page which is going to be shown

order_bystringOptional

The parameter by which the response is ordered.

custom_fieldstringOptional

Filter the response by a custom field value.

order_directionstringOptional

The order direction by which the response is ordered.

referencestringOptional

The reference by which the resource will be filtered.

Response

datalist of objects

pageinteger or null

limitinteger or null

linksobject

total_number_of_pagesinteger or nullDeprecated

Errors

401

Unauthorized Error

403

Forbidden Error

500

Internal Server Error

1	{
2	"data": [
3	{
4	"reference": "string",
5	"type": "ORGANIZATION",
6	"email": "string",
7	"roles": [
8	"DEFAULT"
9	],
10	"object_type": "string",
11	"id": "string",
12	"created_at": "string",
13	"parent_customer_id": "string",
14	"parent_customer_ids": [
15	"string"
16	],
17	"status": "DRAFT",
18	"timezone": "string",
19	"notification_preferences": [
20	{
21	"type": "INVOICE",
22	"channels": [
23	{
24	"type": "EMAIL",
25	"enabled": true
26	}
27	]
28	}
29	],
30	"locale": "string",
31	"individual": {
32	"name": {
33	"first_name": "string",
34	"last_name": "string",
35	"infix": "string"
36	},
37	"residential_address": {
38	"line1": "string",
39	"line2": "string",
40	"city": "string",
41	"postal_code": "string",
42	"state": "string",
43	"country": "AD"
44	}
45	},
46	"organization": {
47	"legal_name": "string",
48	"tax_id": "string",
49	"tax_ids": [
50	{
51	"id": "string",
52	"type": "GENERIC_TAX_ID",
53	"tax_id_validation_result": {
54	"id": "string",
55	"validation_date": "string",
56	"source": "string",
57	"valid": "VALID",
58	"message": "string"
59	}
60	}
61	],
62	"registration_number": "string",
63	"tax_exempt": true,
64	"tax_exempt_note": "string",
65	"registered_address": {
66	"line1": "string",
67	"line2": "string",
68	"city": "string",
69	"postal_code": "string",
70	"state": "string",
71	"country": "AD"
72	},
73	"tax_registrations": [
74	{
75	"id": "string",
76	"description": "string",
77	"tax_id": "string",
78	"tax_ids": [
79	{
80	"id": "string",
81	"type": "GENERIC_TAX_ID",
82	"tax_id_validation_result": {
83	"id": "string",
84	"validation_date": "string",
85	"source": "string",
86	"valid": "VALID",
87	"message": "string"
88	}
89	}
90	],
91	"registration_number": "string",
92	"registered_address": {
93	"line1": "string",
94	"line2": "string",
95	"city": "string",
96	"postal_code": "string",
97	"state": "string",
98	"country": "AD"
99	}
100	}
101	]
102	},
103	"custom_fields": [
104	{
105	"id": "string",
106	"reference": "string",
107	"value": "string",
108	"values": [
109	"string"
110	],
111	"integration_details": {
112	"payment_gateway_variant": "ADYEN",
113	"id": "string",
114	"reference": "string",
115	"adyen": {
116	"recurring_detail_reference": "string"
117	},
118	"stripe": {
119	"payment_method_id": "string"
120	}
121	}
122	}
123	],
124	"processing_only": true,
125	"pricing_plan_subscription_selector": {
126	"data": [
127	{
128	"field": "BILLING_ENTITY_REGISTERED_ADDRESS_COUNTRY",
129	"value": "string"
130	}
131	],
132	"rules": [
133	{
134	"field": "BILLING_ENTITY_REGISTERED_ADDRESS_COUNTRY",
135	"type": "EQUALS"
136	}
137	],
138	"filters": [
139	{
140	"field": "BILLING_ENTITY_REGISTERED_ADDRESS_COUNTRY",
141	"type": "EQUALS",
142	"value": "string"
143	}
144	],
145	"fallback": "LATEST"
146	},
147	"linked_integrations": [
148	{
149	"id": "string",
150	"link_details": [
151	{
152	"url": "string",
153	"custom_field_name": "string"
154	}
155	]
156	}
157	]
158	}
159	],
160	"page": 1,
161	"limit": 1,
162	"links": {
163	"first": "string",
164	"previous": "string",
165	"current": "string",
166	"next": "string"
167	},
168	"total_number_of_pages": 1
169	}

Authentication

Path parameters

Headers

Query parameters

Response

Errors