GET api/Locations?companyId={companyId}
Request Information
URI Parameters
| Name | Description | Type | Additional information |
|---|---|---|---|
| companyId | globally unique identifier |
Required |
Body Parameters
None.
Response Information
Resource Description
Collection of Location| Name | Description | Type | Additional information |
|---|---|---|---|
| id | globally unique identifier |
None. |
|
| name | string |
None. |
|
| abbr | string |
None. |
|
| companyId | globally unique identifier |
None. |
|
| inactive | boolean |
None. |
|
| Company | Company |
None. |
|
| Tickets | Collection of Ticket |
None. |
Response Formats
application/json, text/json
Sample:
[
{
"$id": "1",
"id": "dec1760c-e36d-4bc7-a884-24621ea4f0e9",
"name": "sample string 2",
"abbr": "sample string 3",
"companyId": "b2b36a0d-1766-47b1-8c1c-9a1f5f1e87ed",
"inactive": true,
"Company": {
"$id": "2",
"CompanyId": "749884fb-305c-44f2-85b7-4f33f13c7223",
"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": "f82c7223-e24d-4ef2-80e5-68ea6fee5b3c",
"QuickBooksFile": "sample string 10",
"email": "sample string 11",
"ChargeAccounts": [
{
"$id": "3",
"ID": "9652d7f7-e83d-4fee-b28d-8b5a86fc30fa",
"Name": "sample string 2",
"CompanyId": "a92ef272-2dfb-43fc-9444-721a71f4436f",
"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": "a8f9d210-22b0-41fe-8847-dbf61f3c30da",
"Coupons": 1,
"CloseDate": "2026-06-01T15:32:43Z",
"AccountNumber": "sample string 15",
"Country": "sample string 16",
"FrequentlyUsed": true,
"SortOrder": 1,
"StartDate": "2026-06-01T15:32:43Z",
"InActive": true,
"Password": "sample string 17",
"Company": {
"$ref": "2"
},
"ChargeCards": [
{
"$id": "4",
"ID": "6160b0ee-a195-493e-b17b-924d2cb0090f",
"CompanyId": "253da15f-82c0-4964-a225-b4ee99389355",
"CardNumber": "sample string 3",
"ChargeAccountId": "4ca44d13-365a-4447-851a-2759c5caad47",
"VoidDate": "2026-06-01T15:32:43Z",
"PassengerID": "c8534853-284e-4747-9de8-a89e040d69e9",
"PriceSheetID": "254fe5da-15f2-4d8f-b8d9-9fb0c315973d",
"CardType": "sample string 4",
"VoidReason": "sample string 5",
"CardTypeId": "0800082c-f339-4725-a647-f6d8ff7cbf48",
"CardType1": {
"$id": "5",
"Id": "87c741aa-2352-4082-a519-1a81ce04083a",
"Type": "sample string 2",
"Description": "sample string 3",
"CardStyle": "sample string 4",
"PriceSheetId": "bf928286-3200-40c4-b1d0-8801b6afb5a3",
"ItemId": "40f072e8-fa5d-41cd-940f-57c61e148b3c",
"Discount": true,
"companyId": "6ae06804-48d9-488b-9d14-02b4fee4f876",
"NewCardChargeId": "916c05eb-6a20-46c0-a7a7-de37ae1a49ed",
"rowguid": "5d6c761a-203a-4010-b537-e13379ae4ee6",
"Disclaimer": "sample string 7",
"FromLocationId": "a1a3707d-2beb-459e-9858-16e11942b05a",
"ToLocationId": "46ed7c2e-716b-4d28-bf6e-71ecad4f5eb9",
"ChargeCards": [
{
"$ref": "4"
},
{
"$ref": "4"
}
]
},
"Company": {
"$ref": "2"
},
"Payments": [
{
"$id": "6",
"ID": "0a13b6fd-6cef-4ee6-a6bc-70aa59e66e21",
"TypeId": "24fb8e53-f9ec-4c6a-b033-e8ba35b776f3",
"Type": "sample string 2",
"AccountID": "5917dc56-a704-4b74-84a8-1c3c832ef184",
"Amount": 3.0,
"TicketId": "16abfa81-18f4-4286-b90e-aa8cace3a9d0",
"Coupons": 1,
"ItemId": "24a221a5-54ce-4bfe-adb7-73ba49f7d8e8",
"CreditAuthorization": "sample string 5",
"CreditAuthorizationAmt": 1.0,
"CreditRefNumber": "sample string 6",
"Void": true,
"VoidDateTime": "2026-06-01T15:32:43Z",
"VoidAmt": 1.0,
"VoidRefNumber": "sample string 8",
"Returned": true,
"ReturnDateTime": "2026-06-01T15:32:43Z",
"ReturnAmt": 1.0,
"ReturnRefNumber": "sample string 10",
"CardId": "6c825b5c-da91-4eed-aa50-6d33d56532fe",
"CouponId": "13036ea4-d2d8-4886-8c7e-5b7dcca56dab",
"CouponNumber": "sample string 11",
"Deposit": true,
"Paylater": 1.1,
"ChargeCard": {
"$ref": "4"
},
"PaymentType": {
"$id": "7",
"Id": "c16e62a4-1367-44a6-8eb7-143f8127ab50",
"Type": "sample string 2",
"Description": "sample string 3",
"Display": "sample string 4",
"SortOrder": 5,
"CompanyId": "27f74097-7831-48c5-84c8-2e85cfd895ba",
"ReconcileShow": true,
"Company": {
"$ref": "2"
},
"Payments": [
{
"$ref": "6"
},
{
"$ref": "6"
}
]
},
"Ticket": {
"$id": "8",
"ID": "b7443b0c-6474-44cd-8607-5083b3150666",
"Number": "sample string 2",
"SaleDateTime": "2026-06-01T15:32:43Z",
"SellerID": "d9975fe7-90a1-4966-8a0a-09ff1425a2d6",
"BoardingTime": "2026-06-01T15:32:43Z",
"BoarderID": "c8efde60-d834-44fe-b333-667284d6ecd1",
"Total": 1.0,
"WalletId": "7fb72909-8f66-48ce-9a34-c8df47205dba",
"LocationId": "31207641-6ce8-4ff0-ac76-6809581a31d8",
"PassengerId": "8ffabc31-9708-4a7a-afb0-523fa3512122",
"ReturnTime": "2026-06-01T15:32:43Z",
"ReturnBoarderId": "9cfde061-308b-420c-adf5-aca0f6ae79ab",
"Void": true,
"CompanyId": "e63afd91-623d-4740-b895-4e15436b60a0",
"EntryTime": "2026-06-01T15:32:43Z",
"BoardingBoatId": "ea8609f0-a1ea-4f81-8133-f17fbda787cb",
"BoardingLocationId": "53299b6d-b01d-4cab-b0f7-207a77a9bdcf",
"BoardingTripId": "3e11e71c-fe55-4275-a62a-63125ed47184",
"ReturnBoatId": "f1a8077a-9de7-4967-a042-afd2e0b8804d",
"ReturnLocationId": "3e132594-8087-41e9-8470-dd0266e5946e",
"ReturnTripId": "8511e842-e2a3-49ff-b574-cd59ada217f5",
"roundtrip": true,
"HandHeldSaleNum": "sample string 6",
"ReservationItineraryId": "6673a5b6-569f-4473-8685-7bb9c1677157",
"ReservationTripId": "b6d90a84-568b-42e0-8691-e22e78d5be26",
"Cancelled": true,
"Stay": "sample string 8",
"InternalComments": "sample string 9",
"Memo": "sample string 10",
"CancellationUserId": "5c9c1a7a-a9e7-456d-a52b-270166a5940a",
"FromLocationId": "4f3213e9-5b6d-4f30-b067-d2cd55baf766",
"ToLocationId": "00027f9f-5f86-4a9a-bbe9-ab05e85986b8",
"CancelTime": "2026-06-01T15:32:43Z",
"CancellationUserId1": "ba22d354-5ab2-4f7a-bfd1-7794d35f5a3c",
"CancelTicketid": "576f9af6-4ff8-4e8f-8a13-46085766179b",
"CancelAmount": 1.0,
"Edit": 1,
"RefundAmount": 1.1,
"LineItems": [
{
"$id": "9",
"ID": "d52644c3-f3cf-49a2-9ca2-f430fbb45311",
"TicketID": "accee460-65b6-4990-b7e8-b8220da14515",
"Number": 3,
"Description": "sample string 4",
"Qty": 5.1,
"Total": 6.1,
"ItemID": "ca5f2962-5d1c-44e5-96db-2fc6f6199481",
"Discount": 1.1,
"Coupons": 1,
"CardId": "3601187c-904a-473d-b44f-583f80868872",
"NewCardSale": true,
"GiftCertificateUsed": true,
"Item": {
"$id": "10",
"ID": "50b44a72-3cc1-401a-bc96-86d42908e697",
"ItemNumber": "sample string 2",
"ShortName": "sample string 3",
"Name": "sample string 4",
"Description": "sample string 5",
"ItemType": "625e3d90-41ff-47b4-b9a5-c737663f9ec4",
"SortOrder": 7,
"CompanyId": "5abdb4fe-669c-4119-9fe4-be9f60c11c29",
"OneWayId": "7bcaf1a1-4053-464c-a074-1fc899d8774c",
"RoundTrip": true,
"InActive": true,
"CardPriceSheetId": "bba65694-2738-44ed-b6f5-56c06dedaa84",
"TakesSeat": true,
"Groups": true,
"Expire": 1,
"Disclaimer": "sample string 12",
"quickbooksId": "741d74c7-3581-42df-8e78-7e8c12a4fd18",
"Company": {
"$ref": "2"
},
"RoundTripItems": [
{
"$ref": "10"
},
{
"$ref": "10"
}
],
"OneWayItem": {
"$ref": "10"
},
"PriceSheet": {
"$id": "11",
"ID": "19cabd70-3480-4d4d-9f3c-386e679a8802",
"Name": "sample string 2",
"Description": "sample string 3",
"CompanyId": "47d888aa-f748-405b-8160-e12a6d4fd3fd",
"Basic": "sample string 5",
"StartDate": "2026-06-01T15:32:43Z",
"EndDate": "2026-06-01T15:32:43Z",
"Hierarchy": 6,
"Inactive": true,
"Company": {
"$ref": "2"
},
"Effectives": [
{
"$id": "12",
"EffectiveID": "f52aa284-e412-4990-a4f3-23a88d99f746",
"PriceSheetID": "509a12db-e535-48c6-9f22-152ed3b39e06",
"EffectiveDay": 1,
"EffectiveStartTime": "2026-06-01T15:32:43Z",
"EffectiveEndTime": "2026-06-01T15:32:43Z",
"Checked": "sample string 3",
"PriceSheet": {
"$ref": "11"
}
},
{
"$ref": "12"
}
],
"Items": [
{
"$ref": "10"
},
{
"$ref": "10"
}
],
"Prices": [
{
"$id": "13",
"ID": "64198537-ac17-4fc2-bbd7-ee8aa2213260",
"PriceSheetId": "f0ca0557-d4e7-4aa7-af8f-599b496b24de",
"ItemId": "c16b47f7-f51f-4ca7-be65-f2e1123e805e",
"Price1": 4.0,
"StartDate": "2026-06-01T15:32:43Z",
"EndDate": "2026-06-01T15:32:43Z",
"DefaultPrice": true,
"Item": {
"$ref": "10"
},
"PriceSheet": {
"$ref": "11"
}
},
{
"$ref": "13"
}
],
"ChargeCards": [
{
"$ref": "4"
},
{
"$ref": "4"
}
]
},
"LineItems": [
{
"$ref": "9"
},
{
"$ref": "9"
}
],
"Prices": [
{
"$ref": "13"
},
{
"$ref": "13"
}
]
},
"Ticket": {
"$ref": "8"
},
"ChargeCard": {
"$ref": "4"
}
},
{
"$ref": "9"
}
],
"Payments": [
{
"$ref": "6"
},
{
"$ref": "6"
}
],
"User": {
"$id": "14",
"username": "sample string 4",
"pwdKey": "sample string 14",
"dName": "s.sample string 7",
"id": "4edb1933-0a86-4425-8337-43876efae42b",
"UsersId": "4edb1933-0a86-4425-8337-43876efae42b",
"UserName": "sample string 4",
"DateHired": "2026-06-01T15:32:43Z",
"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-06-01T15:32:43Z",
"inactive": true,
"Email": "sample string 19",
"AccessFailedCount": 1,
"EmailConfirmed": true,
"LockoutEnabled": true,
"LockoutEndDateUtc": "2026-06-01T15:32:43Z",
"PhoneNumberConfirmed": true,
"SecurityStamp": "sample string 20",
"TwoFactorEnabled": true,
"Tickets": [
{
"$ref": "8"
},
{
"$ref": "8"
}
],
"Users_UserPermissions": [
{
"$id": "15",
"Users_UserPermissionsId": "dd732f9a-bf6a-4b04-9a36-115acdc780f3",
"UsersId": "784359c7-6f74-4075-9e17-485a26b8f8ed",
"PermissionsID": "61d33b98-e383-44bd-8642-af5e68932480",
"User": {
"$ref": "14"
}
},
{
"$ref": "15"
}
],
"AccountTransactions": [
{
"$id": "16",
"ID": "4c55502e-4511-4a2e-aeb3-1c29a6fa03b2",
"TransactionDate": "2026-06-01T15:32:43Z",
"Amount": 3.0,
"Type": "sample string 4",
"ChargeAccountID": "3d4421d1-8726-43dd-bdd6-340c009af7b0",
"UserID": "a28730f1-2663-424d-8604-bc7511f8fb95",
"PaymentType": "sample string 6",
"TransactionType": {
"$id": "17",
"TranType": "sample string 1",
"Description": "sample string 2",
"AccountTransactions": [
{
"$ref": "16"
},
{
"$ref": "16"
}
]
},
"User": {
"$ref": "14"
}
},
{
"$ref": "16"
}
],
"User_Role": [
{
"$id": "18",
"UsersId": "ffd869b5-b607-4959-9291-ced00950a858",
"RoleId": "e1ecf26b-f99a-49ed-9060-09558e3603b1",
"TerminationDate": "2026-06-01T15:32:43Z",
"rowguid": "9427f195-2ef8-45f3-8b6b-13dd94a23fc4",
"User": {
"$ref": "14"
}
},
{
"$ref": "18"
}
],
"CompanyUsers": [
{
"$id": "19",
"CompanyUserId": "8ed12321-68ce-4fcc-aca6-c60065b232eb",
"CompanyId": "b1a702ab-4c1a-4503-837c-d4025532225d",
"UsersId": "c347563d-f040-4f1e-a1c4-ef300873df8c",
"UserNumber": "sample string 3",
"StartDate": "2026-06-01T15:32:43Z",
"TerminationDate": "2026-06-01T15:32:43Z",
"Company": {
"$ref": "2"
},
"User": {
"$ref": "14"
}
},
{
"$ref": "19"
}
]
},
"Location": {
"$ref": "1"
},
"Wallet": {
"$id": "20",
"id": "e39a9f11-0bb3-4593-b3f1-2189bb3f12eb",
"Name": "sample string 2",
"companyId": "ffd25b89-8cf0-496a-9c0d-4882da5d3aa4",
"shortName": "sample string 4",
"BoatCrew": true,
"SortOrder": 1,
"Active": true,
"ReconcileShow": true,
"BoatId": "e14e13ef-7b36-4be5-a279-276d4a6f8fc0",
"Company": {
"$ref": "2"
},
"Tickets": [
{
"$ref": "8"
},
{
"$ref": "8"
}
]
}
},
"ChargeAccount": {
"$ref": "3"
}
},
{
"$ref": "6"
}
],
"ChargeAccount": {
"$ref": "3"
},
"PriceSheet": {
"$ref": "11"
},
"LineItems": [
{
"$ref": "9"
},
{
"$ref": "9"
}
]
},
{
"$ref": "4"
}
],
"Payments": [
{
"$ref": "6"
},
{
"$ref": "6"
}
]
},
{
"$ref": "3"
}
],
"ChargeCards": [
{
"$ref": "4"
},
{
"$ref": "4"
}
],
"CompanyUsers": [
{
"$ref": "19"
},
{
"$ref": "19"
}
],
"deviceCompanies": [
{
"$id": "21",
"id": "12feb63d-64d9-4421-87c3-f9d54c6ba828",
"deviceId": "f62691d2-aa48-42a7-96d0-4685cd7aa449",
"companyId": "a09282bf-a812-4743-9036-793680d2b59f",
"voidDate": "2026-06-01T15:32:43Z",
"Company": {
"$ref": "2"
},
"Device": {
"$id": "22",
"id": "1019343c-f75a-4942-ba55-d1fea8f8e1da",
"deviceNumber": "sample string 2",
"deviceName": "sample string 3",
"deviceCompanies": [
{
"$ref": "21"
},
{
"$ref": "21"
}
]
}
},
{
"$ref": "21"
}
],
"Items": [
{
"$ref": "10"
},
{
"$ref": "10"
}
],
"ItemTypes": [
{
"$id": "23",
"ID": "9c4e8a37-45ce-449b-ad03-0b38403a1e3d",
"ShortName": "sample string 2",
"Name": "sample string 3",
"Description": "sample string 4",
"CompanyId": "7322e73d-a805-4499-9435-a5787e411268",
"Company": {
"$ref": "2"
}
},
{
"$ref": "23"
}
],
"Locations": [
{
"$ref": "1"
},
{
"$ref": "1"
}
],
"PaymentTypes": [
{
"$ref": "7"
},
{
"$ref": "7"
}
],
"PriceSheets": [
{
"$ref": "11"
},
{
"$ref": "11"
}
],
"Roles": [
{
"$id": "24",
"RoleId": "a0eed62a-089b-4ace-a3e1-f8ad5dc8c57c",
"CompanyId": "c2cd44c7-38d4-45da-9fa8-52636ba2d6bc",
"RoleName": "sample string 2",
"Active": true,
"DateRange": 1,
"PasswordChange": 1,
"Company": {
"$ref": "2"
},
"Role_Permissions": [
{
"$id": "25",
"RoleId": "0bcde5b3-046c-4400-ae7f-1a8671e47316",
"PermissionsId": "36d01b1a-7ecd-4784-a6f1-9d018df8b2da",
"Role_PermissionsId": "51d20a95-effe-4e84-be35-6dd13b34bf00",
"Role": {
"$ref": "24"
}
},
{
"$ref": "25"
}
]
},
{
"$ref": "24"
}
],
"UserPermissions": [
{
"$id": "26",
"UserPermissionId": "9d803d0c-87fb-4793-a096-a5e3f089b223",
"PermissionsId": "a350d55b-b73a-4b41-8d64-f0791ee84702",
"CompanyId": "ae79712a-6696-4820-a6f5-d17c73f852d2",
"ReadWrite": true,
"Company": {
"$ref": "2"
},
"Permission": {
"$id": "27",
"PermissionsId": "8cc9f9bb-30cc-47de-a69e-14e0ed5261ed",
"TypePermission": "sample string 2",
"Name": "sample string 3",
"Description": "sample string 4",
"parentId": "bd8fa846-7d9a-4dbe-9be8-43830d939458",
"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"
}
]
},
"Tickets": [
{
"$ref": "8"
},
{
"$ref": "8"
}
]
},
{
"$ref": "1"
}
]