API Version 2
  • API V2 Overview
  • Category
    • Company
      • Customers
        • Orders
          • Pages
            • Page Templates
              • Products
                • Purchase Orders
                  • SKUs
                    • Support Tickets
                      • Tax Regions
                        • Vendors
                          • Warehouses
                            API Documentation

                            companies/info

                            Type Info
                            List Companies
                            URL http://{domain}/api/v2/companies/info.json
                            Accepts Filters No
                            Output Attributes
                            Yes


                            Companies Info Data

                            Gets companies info.
                            Filters
                            Filter the companies into a list.
                            Parameter Type Rules Example
                            id int / array one id or multiple Lead Commerce company ids
                            1 or array(3,8,9,45)

                            Response

                            Example JSON returned
                            {
                              "code": "200",
                              "data": {
                                "1": [
                                  {
                                    "id": "1",
                                    "name": "ABC Company",
                                    "status": "1",
                                    "attributes": [
                                      {
                                        "id": "16",
                                        "name": "MN Code",
                                        "display_name": "MN Code",
                                        "slug": "attr_mn_code",
                                        "value": "ABX"
                                      }
                                    ]
                                  }
                                ],
                                "2": [
                                  {
                                    "id": "2",
                                    "name": "Coffee Shop Company",
                                    "status": "1",
                                    "attributes": ""
                                  }
                                ]
                              }
                            }
                            

                            Start your free, no-risk trial today.