customercompanies

GET

/api/v3/customercompanies

Last modified:2026-05-04 09:11:01

Request

Authorization

Basic Auth

Send your HTTP requests with an

Authorization

header that contains the word Basic followed by a space and a base64-encoded string username:password

Example:

Authorization: Basic *****************

Bearer Token

Provide your bearer token in the

Authorization

header when making requests to protected resources.

Example:

Authorization: Bearer ********************

Query Params

Header Params

Request Code Samples

Shell

JavaScript

Java

Swift

PHP

Python

HTTP

Objective-C

Ruby

OCaml

Dart

curl --location 'https://prod.your-api-server.com/api/v3/customercompanies?page=1&pagesize=2' \
--header 'Authorization: Basic <encoded-value>'

Responses

🟢200Success

application/json

Bodyapplication/json

Example

{
    "data": [
        {
            "id": 87,
            "companyname": "Azienda Cliente srl",
            "email": "aziendacliente@example.com",
            "taxcode": "444555666",
            "vatnumber": "12312312123",
            "address": "Via Roma",
            "cap": "00100",
            "city": "Roma",
            "province": "RM",
            "phoneNo": "",
            "mobileNo": "+393330000300",
            "country": "IT",
            "companyid": 15,
            "supplierid": 435,
            "supplier": {
                "id": 435,
                "code": null,
                "name": "Azienda Cliente srl",
                "mailname": null,
                "phone": null,
                "fax": null,
                "email": "aziendacliente@example.com",
                "mobile": null,
                "taxcode": "444555666",
                "vat": "12312312123",
                "address": "Via Roma",
                "cap": "00100",
                "city": "Roma",
                "province": "RM",
                "country": "IT",
                "istraining": 0,
                "contacts": [
                    {
                        "id": 2,
                        "supplierid": 435,
                        "name": "Aldo",
                        "surname": "Rame",
                        "leadid": null,
                        "phone": "+393896001787",
                        "mobile": "+393896001787",
                        "email": "arame@raldo.it"
                    },
                    {
                        "id": 3,
                        "supplierid": 435,
                        "name": "Pero",
                        "surname": "Bronzo",
                        "leadid": null,
                        "phone": "+393692581470",
                        "mobile": "+390147258369",
                        "email": "pero@bronzo.it"
                    },
                    {
                        "id": 4,
                        "supplierid": 435,
                        "name": "luca",
                        "surname": "alberto",
                        "leadid": 14886,
                        "phone": "+397894561230",
                        "mobile": "+397894561230",
                        "email": "luca@alberto.luca"
                    }
                ],
                "studentsTraining": []
            }
        },
        {
            "id": 88,
            "companyname": "Custom Company spa",
            "email": "clientespa@example.com",
            "taxcode": "5498132514981",
            "vatnumber": "777855441263",
            "address": "via Milano",
            "cap": "20126",
            "city": "Milano",
            "province": "MI",
            "phoneNo": "",
            "mobileNo": "",
            "country": "IT",
            "companyid": 15,
            "supplierid": 436,
            "supplier": {
                "id": 436,
                "code": null,
                "name": "Custom Company spa",
                "mailname": null,
                "phone": null,
                "fax": null,
                "email": "clientespa@example.com",
                "mobile": null,
                "taxcode": "5498132514981",
                "vat": "777855441263",
                "address": "via Milano",
                "cap": "20126",
                "city": "Milano",
                "province": "MI",
                "country": "IT",
                "istraining": 0,
                "contacts": [],
                "studentsTraining": []
            }
        }
    ],
    "links": {
        "first": "https://demo.scuolasemplice.it/api/v3/customercompanies?include=supplier.contacts%2Csupplier.studentsTraining&pagesize=2&page=1",
        "last": "https://demo.scuolasemplice.it/api/v3/customercompanies?include=supplier.contacts%2Csupplier.studentsTraining&pagesize=2&page=2",
        "prev": null,
        "next": "https://demo.scuolasemplice.it/api/v3/customercompanies?include=supplier.contacts%2Csupplier.studentsTraining&pagesize=2&page=2"
    },
    "meta": {
        "current_page": 1,
        "from": 1,
        "last_page": 2,
        "links": [
            {
                "url": null,
                "label": "&laquo; Previous",
                "active": false
            },
            {
                "url": "https://demo.scuolasemplice.it/api/v3/customercompanies?include=supplier.contacts%2Csupplier.studentsTraining&pagesize=2&page=1",
                "label": "1",
                "active": true
            },
            {
                "url": "https://demo.scuolasemplice.it/api/v3/customercompanies?include=supplier.contacts%2Csupplier.studentsTraining&pagesize=2&page=2",
                "label": "2",
                "active": false
            },
            {
                "url": "https://demo.scuolasemplice.it/api/v3/customercompanies?include=supplier.contacts%2Csupplier.studentsTraining&pagesize=2&page=2",
                "label": "Next &raquo;",
                "active": false
            }
        ],
        "path": "https://demo.scuolasemplice.it/api/v3/customercompanies",
        "per_page": 2,
        "to": 2,
        "total": 4
    }
}

Modified at 2026-05-04 09:11:01

update by externid

customercompanies/{id}