Get customers

You can fetch a list of all the customers in your platform as follows.

GET /customers?filter[name]=Acm

The name filter is optional and can take a partial customer name to filter the results.

Response

{
    "data": [
        {
            "id": "687108914e0bed9042072fb7",
            "price_plan": {
                "id": "687108914e0bed9042072fb6",
                "name": "Default price plan",
                "_document_type": "price_plan"
            },
            "account_manager": {
                "id": "687108914e0bed9042072fb5",
                "first_name": "John",
                "last_name": "Doe",
                "_document_type": "user"
            },
            "interconnected": true,
            "apply_vat": true,
            "auto_number": "CUS-1234",
            "name": "Acme Corp",
            "external_id": "EXT-ACME-001",
            "legal_name": "Acme Corporation LLC",
            "business_registration_number": "BRN-123456789",
            "website": "https://www.acmecorp.example.com",
            "_document_type": "customer"
        },
        {
            "id": "687108914e0bed9042072fb7",
            "price_plan": {
                "id": "687108914e0bed9042072fb6",
                "name": "Default price plan",
                "_document_type": "price_plan"
            },
            "account_manager": {
                "id": "687108914e0bed9042072fb5",
                "first_name": "John",
                "last_name": "Doe",
                "_document_type": "user"
            },
            "interconnected": true,
            "apply_vat": true,
            "auto_number": "CUS-1234",
            "name": "Acme Corp",
            "external_id": "EXT-ACME-001",
            "legal_name": "Acme Corporation LLC",
            "business_registration_number": "BRN-123456789",
            "website": "https://www.acmecorp.example.com",
            "_document_type": "customer"
        },
        ...
    ],
}