GET api/Companies

Request Information

URI Parameters

None.

Body Parameters

None.

Response Information

Resource Description

Collection of Company
NameDescriptionTypeAdditional information
CompanyId

globally unique identifier

None.

CompanyName

string

None.

CompanyCode

string

None.

Address

string

None.

City

string

None.

State

string

None.

ZipCode

string

None.

Website

string

None.

Phone

string

None.

IndustryId

globally unique identifier

None.

QuickBooksFile

string

None.

email

string

None.

ChargeAccounts

Collection of ChargeAccount

None.

ChargeCards

Collection of ChargeCard

None.

CompanyUsers

Collection of CompanyUser

None.

deviceCompanies

Collection of deviceCompany

None.

Items

Collection of Item

None.

ItemTypes

Collection of ItemType

None.

Locations

Collection of Location

None.

PaymentTypes

Collection of PaymentType

None.

PriceSheets

Collection of PriceSheet

None.

Roles

Collection of Role

None.

UserPermissions

Collection of UserPermission

None.

Wallets

Collection of Wallet

None.

Response Formats

application/json, text/json

Sample:
[
  {
    "$id": "1",
    "CompanyId": "48b47c87-ebff-4de9-aa1c-4273d0c6e1bf",
    "CompanyName": "sample string 2",
    "CompanyCode": "sample string 3",
    "Address": "sample string 4",
    "City": "sample string 5",
    "State": "sample string 6",
    "ZipCode": "sample string 7",
    "Website": "sample string 8",
    "Phone": "sample string 9",
    "IndustryId": "844d10c5-b8c6-4622-bd10-d51a89e8bff2",
    "QuickBooksFile": "sample string 10",
    "email": "sample string 11",
    "ChargeAccounts": [
      {
        "$id": "2",
        "ID": "c918f15f-4be3-4cce-926d-cfba0e897126",
        "Name": "sample string 2",
        "CompanyId": "e64e41d3-ba67-4731-8e56-125bfa271da2",
        "CurrentBalance": 4.0,
        "LowBalance": 1.0,
        "Address1": "sample string 5",
        "Address2": "sample string 6",
        "City": "sample string 7",
        "State": "sample string 8",
        "ZipCode": "sample string 9",
        "Phone": "sample string 10",
        "email": "sample string 11",
        "ContactName": "sample string 12",
        "Status": "sample string 13",
        "AcctType": "sample string 14",
        "PriceSheetId": "806b8c8c-4548-4b16-8338-3b716340c090",
        "Coupons": 1,
        "CloseDate": "2026-01-24T22:38:57Z",
        "AccountNumber": "sample string 15",
        "Country": "sample string 16",
        "FrequentlyUsed": true,
        "SortOrder": 1,
        "StartDate": "2026-01-24T22:38:57Z",
        "InActive": true,
        "Password": "sample string 17",
        "Company": {
          "$ref": "1"
        },
        "ChargeCards": [
          {
            "$id": "3",
            "ID": "5bb11888-4da4-4122-97af-e974d82eb118",
            "CompanyId": "d517b830-e821-43e3-bd5f-daa4277cd790",
            "CardNumber": "sample string 3",
            "ChargeAccountId": "a536c40f-7e03-465e-9aa5-a3ad298379ea",
            "VoidDate": "2026-01-24T22:38:57Z",
            "PassengerID": "ea8b789f-46ac-4b25-8da2-9f305e4a81a8",
            "PriceSheetID": "db88e567-270e-4695-a482-82bb3b541b12",
            "CardType": "sample string 4",
            "VoidReason": "sample string 5",
            "CardTypeId": "bdeb9337-0693-4784-b44e-f55fe576aea7",
            "CardType1": {
              "$id": "4",
              "Id": "22955a28-da2e-45ef-a309-0211e26c45d9",
              "Type": "sample string 2",
              "Description": "sample string 3",
              "CardStyle": "sample string 4",
              "PriceSheetId": "a407c9f7-e3ec-4941-8c0c-8483a1bad522",
              "ItemId": "c3ef7712-75a5-47ac-986a-478be3678faf",
              "Discount": true,
              "companyId": "7f8c6b0a-4196-465a-9038-1f647b9a4d3e",
              "NewCardChargeId": "e698ce1e-757f-4592-bff0-60d8279d811e",
              "rowguid": "c8058247-1226-4020-b23f-43721d86abad",
              "Disclaimer": "sample string 7",
              "FromLocationId": "60eeaf3b-b864-416d-a1a2-c7104aa98cc8",
              "ToLocationId": "1d08f4fd-4d62-45f5-977b-70f07b1bc52a",
              "ChargeCards": [
                {
                  "$ref": "3"
                },
                {
                  "$ref": "3"
                }
              ]
            },
            "Company": {
              "$ref": "1"
            },
            "Payments": [
              {
                "$id": "5",
                "ID": "ec66b8e6-b5c2-497d-b507-5403a43cb557",
                "TypeId": "60fcac56-0673-42ad-94dc-f71fcd3ed667",
                "Type": "sample string 2",
                "AccountID": "1fa31377-9196-49a5-a330-3ba81c790645",
                "Amount": 3.0,
                "TicketId": "47ebccaf-c3b1-4636-b97b-7c30ad440b40",
                "Coupons": 1,
                "ItemId": "d25a87bb-58b5-4685-8e4f-e7b9464db0e3",
                "CreditAuthorization": "sample string 5",
                "CreditAuthorizationAmt": 1.0,
                "CreditRefNumber": "sample string 6",
                "Void": true,
                "VoidDateTime": "2026-01-24T22:38:57Z",
                "VoidAmt": 1.0,
                "VoidRefNumber": "sample string 8",
                "Returned": true,
                "ReturnDateTime": "2026-01-24T22:38:57Z",
                "ReturnAmt": 1.0,
                "ReturnRefNumber": "sample string 10",
                "CardId": "032a198f-7f01-4acd-b5c6-23aa88f2d074",
                "CouponId": "563a5b5d-a352-46fa-8f0e-2dcdb5f79b1f",
                "CouponNumber": "sample string 11",
                "Deposit": true,
                "Paylater": 1.1,
                "ChargeCard": {
                  "$ref": "3"
                },
                "PaymentType": {
                  "$id": "6",
                  "Id": "3cbdc76f-3d84-401f-b36d-a7b527aac9f2",
                  "Type": "sample string 2",
                  "Description": "sample string 3",
                  "Display": "sample string 4",
                  "SortOrder": 5,
                  "CompanyId": "e5ad469b-2088-4d91-b9db-d4545ec1cb82",
                  "ReconcileShow": true,
                  "Company": {
                    "$ref": "1"
                  },
                  "Payments": [
                    {
                      "$ref": "5"
                    },
                    {
                      "$ref": "5"
                    }
                  ]
                },
                "Ticket": {
                  "$id": "7",
                  "ID": "bb8818d9-3206-441d-b77d-d514070d135b",
                  "Number": "sample string 2",
                  "SaleDateTime": "2026-01-24T22:38:57Z",
                  "SellerID": "57c874a6-786c-4497-b28c-a8af78151613",
                  "BoardingTime": "2026-01-24T22:38:57Z",
                  "BoarderID": "c74d42c4-dcbf-4ad2-b983-0ae60bcb9c4d",
                  "Total": 1.0,
                  "WalletId": "1f002f74-cdb7-4174-8d47-acf9a45be96e",
                  "LocationId": "9bdd2848-24a6-4d04-a107-52a9a105cc35",
                  "PassengerId": "4ef47d84-63ef-45cb-b2a2-c850efffe369",
                  "ReturnTime": "2026-01-24T22:38:57Z",
                  "ReturnBoarderId": "2eaaaa17-f009-4b06-9a7e-be8ed2056b16",
                  "Void": true,
                  "CompanyId": "9aa25ef9-1ba4-4a5c-9709-4f513f75be8b",
                  "EntryTime": "2026-01-24T22:38:57Z",
                  "BoardingBoatId": "63141152-882e-4d93-85b8-b3e71df44b78",
                  "BoardingLocationId": "3c9525fc-9e47-4d3f-aa0c-4e4c4cc34746",
                  "BoardingTripId": "75a1d235-7614-4ffd-887d-356fcca460ce",
                  "ReturnBoatId": "0b52c1cd-e5da-437a-aac6-003163ff4b10",
                  "ReturnLocationId": "d8e8ad9f-e73c-4803-89aa-65e2ac1f28c1",
                  "ReturnTripId": "7990085e-936b-4015-98fe-de580ac5efc8",
                  "roundtrip": true,
                  "HandHeldSaleNum": "sample string 6",
                  "ReservationItineraryId": "ce09abf6-34f9-41dd-b24a-73a902361bf1",
                  "ReservationTripId": "28234485-9fd3-4f8b-87bb-f7540b48a825",
                  "Cancelled": true,
                  "Stay": "sample string 8",
                  "InternalComments": "sample string 9",
                  "Memo": "sample string 10",
                  "CancellationUserId": "7341f1d9-0515-4390-8113-006a60a37a02",
                  "FromLocationId": "b36ce561-e84c-4af7-8867-a882c3e9826a",
                  "ToLocationId": "4cb33fce-2f84-4a96-ab80-e53fb2600a71",
                  "CancelTime": "2026-01-24T22:38:57Z",
                  "CancellationUserId1": "14af1623-9b18-4d6d-94ec-22ee923149d3",
                  "CancelTicketid": "021c8a13-8f53-4261-8173-ef3d9d441c25",
                  "CancelAmount": 1.0,
                  "Edit": 1,
                  "RefundAmount": 1.1,
                  "LineItems": [
                    {
                      "$id": "8",
                      "ID": "2548761c-00c2-4e70-a7b2-a4bf0969fe26",
                      "TicketID": "f617bfaf-6d27-42ea-85d8-f66c9a04dc2a",
                      "Number": 3,
                      "Description": "sample string 4",
                      "Qty": 5.1,
                      "Total": 6.1,
                      "ItemID": "3481b5fd-094c-43b7-a908-a5fbed4c9da4",
                      "Discount": 1.1,
                      "Coupons": 1,
                      "CardId": "1929ea03-e156-4b81-b7dd-90388565910a",
                      "NewCardSale": true,
                      "GiftCertificateUsed": true,
                      "Item": {
                        "$id": "9",
                        "ID": "1e90ded0-c9b5-4069-944d-9c3c01564a21",
                        "ItemNumber": "sample string 2",
                        "ShortName": "sample string 3",
                        "Name": "sample string 4",
                        "Description": "sample string 5",
                        "ItemType": "e5b637c1-142e-42a7-a2ef-6ace9b146337",
                        "SortOrder": 7,
                        "CompanyId": "7fccf4f3-f879-4959-82c3-7b3692048ff2",
                        "OneWayId": "f67b5d49-1ec7-4f5d-af22-aaaa4c6f5b14",
                        "RoundTrip": true,
                        "InActive": true,
                        "CardPriceSheetId": "cc5c1a01-e99f-402a-9727-f6c1169d6758",
                        "TakesSeat": true,
                        "Groups": true,
                        "Expire": 1,
                        "Disclaimer": "sample string 12",
                        "quickbooksId": "dd7b3ebc-eda3-491d-bb65-3dc9ed596cbf",
                        "Company": {
                          "$ref": "1"
                        },
                        "RoundTripItems": [
                          {
                            "$ref": "9"
                          },
                          {
                            "$ref": "9"
                          }
                        ],
                        "OneWayItem": {
                          "$ref": "9"
                        },
                        "PriceSheet": {
                          "$id": "10",
                          "ID": "7a0febb1-2431-41f1-97ca-73bb406a6a0d",
                          "Name": "sample string 2",
                          "Description": "sample string 3",
                          "CompanyId": "e3345bf6-6c74-4580-941d-6ca75b5ad4f3",
                          "Basic": "sample string 5",
                          "StartDate": "2026-01-24T22:38:57Z",
                          "EndDate": "2026-01-24T22:38:57Z",
                          "Hierarchy": 6,
                          "Inactive": true,
                          "Company": {
                            "$ref": "1"
                          },
                          "Effectives": [
                            {
                              "$id": "11",
                              "EffectiveID": "7ccef9cb-1289-4a3f-a2c1-42c4e464a69c",
                              "PriceSheetID": "79abdec2-51ab-42d4-8532-01a45a198571",
                              "EffectiveDay": 1,
                              "EffectiveStartTime": "2026-01-24T22:38:57Z",
                              "EffectiveEndTime": "2026-01-24T22:38:57Z",
                              "Checked": "sample string 3",
                              "PriceSheet": {
                                "$ref": "10"
                              }
                            },
                            {
                              "$ref": "11"
                            }
                          ],
                          "Items": [
                            {
                              "$ref": "9"
                            },
                            {
                              "$ref": "9"
                            }
                          ],
                          "Prices": [
                            {
                              "$id": "12",
                              "ID": "5054ae56-aa36-4a0a-9e73-242e38c9e1cf",
                              "PriceSheetId": "74c4fc30-22a9-4bd5-b581-c1168d275107",
                              "ItemId": "bcf2c12d-a0b8-472f-84ee-9890dc4bebaa",
                              "Price1": 4.0,
                              "StartDate": "2026-01-24T22:38:57Z",
                              "EndDate": "2026-01-24T22:38:57Z",
                              "DefaultPrice": true,
                              "Item": {
                                "$ref": "9"
                              },
                              "PriceSheet": {
                                "$ref": "10"
                              }
                            },
                            {
                              "$ref": "12"
                            }
                          ],
                          "ChargeCards": [
                            {
                              "$ref": "3"
                            },
                            {
                              "$ref": "3"
                            }
                          ]
                        },
                        "LineItems": [
                          {
                            "$ref": "8"
                          },
                          {
                            "$ref": "8"
                          }
                        ],
                        "Prices": [
                          {
                            "$ref": "12"
                          },
                          {
                            "$ref": "12"
                          }
                        ]
                      },
                      "Ticket": {
                        "$ref": "7"
                      },
                      "ChargeCard": {
                        "$ref": "3"
                      }
                    },
                    {
                      "$ref": "8"
                    }
                  ],
                  "Payments": [
                    {
                      "$ref": "5"
                    },
                    {
                      "$ref": "5"
                    }
                  ],
                  "User": {
                    "$id": "13",
                    "username": "sample string 4",
                    "pwdKey": "sample string 14",
                    "dName": "s.sample string 7",
                    "id": "fab1bcee-1e35-4966-898c-9a7ad3d7db7a",
                    "UsersId": "fab1bcee-1e35-4966-898c-9a7ad3d7db7a",
                    "UserName": "sample string 4",
                    "DateHired": "2026-01-24T22:38:57Z",
                    "FirstName": "sample string 5",
                    "MiddleName": "sample string 6",
                    "LastName": "sample string 7",
                    "Address": "sample string 8",
                    "City": "sample string 9",
                    "State": "sample string 10",
                    "ZipCode": "sample string 11",
                    "Phone": "sample string 12",
                    "Cell": "sample string 13",
                    "Password": "sample string 14",
                    "sql": "sample string 15",
                    "pwd": "sample string 16",
                    "timechanged": "2026-01-24T22:38:57Z",
                    "inactive": true,
                    "Email": "sample string 19",
                    "AccessFailedCount": 1,
                    "EmailConfirmed": true,
                    "LockoutEnabled": true,
                    "LockoutEndDateUtc": "2026-01-24T22:38:57Z",
                    "PhoneNumberConfirmed": true,
                    "SecurityStamp": "sample string 20",
                    "TwoFactorEnabled": true,
                    "Tickets": [
                      {
                        "$ref": "7"
                      },
                      {
                        "$ref": "7"
                      }
                    ],
                    "Users_UserPermissions": [
                      {
                        "$id": "14",
                        "Users_UserPermissionsId": "f6a42941-a862-46d3-83fe-1677e80c04b3",
                        "UsersId": "d7c03b56-6dc7-466d-b5e6-5acff44a82c9",
                        "PermissionsID": "b1f68565-8786-4aae-a63b-67230c3931ef",
                        "User": {
                          "$ref": "13"
                        }
                      },
                      {
                        "$ref": "14"
                      }
                    ],
                    "AccountTransactions": [
                      {
                        "$id": "15",
                        "ID": "ec6ddb1b-da94-4298-910c-65bfe2fdad78",
                        "TransactionDate": "2026-01-24T22:38:57Z",
                        "Amount": 3.0,
                        "Type": "sample string 4",
                        "ChargeAccountID": "af624e3a-21db-4ea3-85ae-2f69c6e73aeb",
                        "UserID": "0a616899-964f-4f41-be0c-aa94019dd2e9",
                        "PaymentType": "sample string 6",
                        "TransactionType": {
                          "$id": "16",
                          "TranType": "sample string 1",
                          "Description": "sample string 2",
                          "AccountTransactions": [
                            {
                              "$ref": "15"
                            },
                            {
                              "$ref": "15"
                            }
                          ]
                        },
                        "User": {
                          "$ref": "13"
                        }
                      },
                      {
                        "$ref": "15"
                      }
                    ],
                    "User_Role": [
                      {
                        "$id": "17",
                        "UsersId": "031ae767-1844-44ef-bdf0-e47785f68a6c",
                        "RoleId": "25ca6582-7cd6-4cc5-abc0-c3bf8e77649c",
                        "TerminationDate": "2026-01-24T22:38:57Z",
                        "rowguid": "76af30dd-f5f7-40d0-a508-0522a8e53505",
                        "User": {
                          "$ref": "13"
                        }
                      },
                      {
                        "$ref": "17"
                      }
                    ],
                    "CompanyUsers": [
                      {
                        "$id": "18",
                        "CompanyUserId": "762622b7-5b7a-41bf-a100-eefe3237af15",
                        "CompanyId": "488a6857-c350-444a-b8cd-169098f99340",
                        "UsersId": "a4582ffc-01ef-496d-82f6-85fa0eb75e04",
                        "UserNumber": "sample string 3",
                        "StartDate": "2026-01-24T22:38:57Z",
                        "TerminationDate": "2026-01-24T22:38:57Z",
                        "Company": {
                          "$ref": "1"
                        },
                        "User": {
                          "$ref": "13"
                        }
                      },
                      {
                        "$ref": "18"
                      }
                    ]
                  },
                  "Location": {
                    "$id": "19",
                    "id": "ef16edac-0ae1-4584-8a4d-707650fee3ec",
                    "name": "sample string 2",
                    "abbr": "sample string 3",
                    "companyId": "f82bc595-d654-422e-976b-b30302f9d332",
                    "inactive": true,
                    "Company": {
                      "$ref": "1"
                    },
                    "Tickets": [
                      {
                        "$ref": "7"
                      },
                      {
                        "$ref": "7"
                      }
                    ]
                  },
                  "Wallet": {
                    "$id": "20",
                    "id": "948f8b13-1d0b-49d2-a05b-d370b0abd25f",
                    "Name": "sample string 2",
                    "companyId": "2503502d-b24a-4e20-be71-25cd4da3db81",
                    "shortName": "sample string 4",
                    "BoatCrew": true,
                    "SortOrder": 1,
                    "Active": true,
                    "ReconcileShow": true,
                    "BoatId": "7f1cc978-6876-4c36-afa5-c9471264d223",
                    "Company": {
                      "$ref": "1"
                    },
                    "Tickets": [
                      {
                        "$ref": "7"
                      },
                      {
                        "$ref": "7"
                      }
                    ]
                  }
                },
                "ChargeAccount": {
                  "$ref": "2"
                }
              },
              {
                "$ref": "5"
              }
            ],
            "ChargeAccount": {
              "$ref": "2"
            },
            "PriceSheet": {
              "$ref": "10"
            },
            "LineItems": [
              {
                "$ref": "8"
              },
              {
                "$ref": "8"
              }
            ]
          },
          {
            "$ref": "3"
          }
        ],
        "Payments": [
          {
            "$ref": "5"
          },
          {
            "$ref": "5"
          }
        ]
      },
      {
        "$ref": "2"
      }
    ],
    "ChargeCards": [
      {
        "$ref": "3"
      },
      {
        "$ref": "3"
      }
    ],
    "CompanyUsers": [
      {
        "$ref": "18"
      },
      {
        "$ref": "18"
      }
    ],
    "deviceCompanies": [
      {
        "$id": "21",
        "id": "601f6618-2045-4cd6-93ff-a502678bb711",
        "deviceId": "c8c18690-cfe3-4021-90a7-4afd7d3926e4",
        "companyId": "fbd5ef9e-a070-4f27-9294-933459588468",
        "voidDate": "2026-01-24T22:38:57Z",
        "Company": {
          "$ref": "1"
        },
        "Device": {
          "$id": "22",
          "id": "7792c13a-faaa-41ca-8e25-9cbd1c22f30f",
          "deviceNumber": "sample string 2",
          "deviceName": "sample string 3",
          "deviceCompanies": [
            {
              "$ref": "21"
            },
            {
              "$ref": "21"
            }
          ]
        }
      },
      {
        "$ref": "21"
      }
    ],
    "Items": [
      {
        "$ref": "9"
      },
      {
        "$ref": "9"
      }
    ],
    "ItemTypes": [
      {
        "$id": "23",
        "ID": "399ea0f0-d5dc-4b90-a0d9-f4660c3958ad",
        "ShortName": "sample string 2",
        "Name": "sample string 3",
        "Description": "sample string 4",
        "CompanyId": "37524400-61bb-4404-91f5-8c4886f1d250",
        "Company": {
          "$ref": "1"
        }
      },
      {
        "$ref": "23"
      }
    ],
    "Locations": [
      {
        "$ref": "19"
      },
      {
        "$ref": "19"
      }
    ],
    "PaymentTypes": [
      {
        "$ref": "6"
      },
      {
        "$ref": "6"
      }
    ],
    "PriceSheets": [
      {
        "$ref": "10"
      },
      {
        "$ref": "10"
      }
    ],
    "Roles": [
      {
        "$id": "24",
        "RoleId": "5b7be056-e094-476b-ad35-ecdacf7fbf03",
        "CompanyId": "45d14e5a-e501-49dc-b404-95434c7286b0",
        "RoleName": "sample string 2",
        "Active": true,
        "DateRange": 1,
        "PasswordChange": 1,
        "Company": {
          "$ref": "1"
        },
        "Role_Permissions": [
          {
            "$id": "25",
            "RoleId": "81ac360a-8f0b-4ff5-8d1b-d547f02b85bf",
            "PermissionsId": "2bd4490d-59a0-45ae-a9fc-26e30f041278",
            "Role_PermissionsId": "b8c21fc3-a3db-4669-bd60-0263676b8f4b",
            "Role": {
              "$ref": "24"
            }
          },
          {
            "$ref": "25"
          }
        ]
      },
      {
        "$ref": "24"
      }
    ],
    "UserPermissions": [
      {
        "$id": "26",
        "UserPermissionId": "2b5b6648-1ca5-4f75-88d6-5c578691bc36",
        "PermissionsId": "d06b1232-e44c-46f0-8d4d-bfbee3aafe3d",
        "CompanyId": "03dccd60-c805-4b12-a4f7-7a544e0ab427",
        "ReadWrite": true,
        "Company": {
          "$ref": "1"
        },
        "Permission": {
          "$id": "27",
          "PermissionsId": "cdcc64c0-d340-4300-876e-453303d64273",
          "TypePermission": "sample string 2",
          "Name": "sample string 3",
          "Description": "sample string 4",
          "parentId": "aec378b8-d303-44d1-945e-408b386584b1",
          "MenuSize": 1,
          "ParentItem": 1,
          "MenuOrder": 1,
          "menuTarget": "sample string 5",
          "CostPerUnit": 1.1,
          "Permissions1": [
            {
              "$ref": "27"
            },
            {
              "$ref": "27"
            }
          ],
          "Permission1": {
            "$ref": "27"
          },
          "UserPermissions": [
            {
              "$ref": "26"
            },
            {
              "$ref": "26"
            }
          ]
        }
      },
      {
        "$ref": "26"
      }
    ],
    "Wallets": [
      {
        "$ref": "20"
      },
      {
        "$ref": "20"
      }
    ]
  },
  {
    "$ref": "1"
  }
]