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": "96a26f2e-8691-4b90-84ec-e82335fcf828",
"name": "sample string 2",
"abbr": "sample string 3",
"companyId": "f6c6b83c-533b-4953-ad84-4d7591ae193d",
"inactive": true,
"Company": {
"$id": "2",
"CompanyId": "a732da06-b949-4c32-961b-457eba27a384",
"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": "0a669fdf-ee83-434f-9cb7-6cf8d24e1ce4",
"QuickBooksFile": "sample string 10",
"email": "sample string 11",
"ChargeAccounts": [
{
"$id": "3",
"ID": "3683404c-0777-4327-87e8-febd78a230cb",
"Name": "sample string 2",
"CompanyId": "11789279-f1b5-4760-8ba0-449d2115c3ad",
"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": "949c4ac1-9ca0-4343-9031-e2f4bdd1cb58",
"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": "2"
},
"ChargeCards": [
{
"$id": "4",
"ID": "de771ea7-6cfe-4be1-a673-ff20d8c2661e",
"CompanyId": "f4971805-5591-497f-b923-b3a1379e64cf",
"CardNumber": "sample string 3",
"ChargeAccountId": "7ec133d0-8ed4-4d5b-9e1d-3496692dfcbe",
"VoidDate": "2026-01-24T22:38:57Z",
"PassengerID": "216490aa-ed38-498f-b42c-18732dac3e66",
"PriceSheetID": "63a40628-5ce9-4126-9120-99a02313c4e4",
"CardType": "sample string 4",
"VoidReason": "sample string 5",
"CardTypeId": "cf70c299-7ab4-492a-8b15-5d4dfa66ca93",
"CardType1": {
"$id": "5",
"Id": "7cc5615b-a90d-433b-a40f-3d414bbe9b2c",
"Type": "sample string 2",
"Description": "sample string 3",
"CardStyle": "sample string 4",
"PriceSheetId": "ceacf271-aed5-4afe-b231-7a18b127d7a5",
"ItemId": "6c50ae48-a2d3-4d9d-9d0b-21bbdca931b1",
"Discount": true,
"companyId": "f1587f5e-8c0e-4a43-836a-e81c37c79d73",
"NewCardChargeId": "0ae29f80-71cb-4e95-8c27-d9e3cb51804e",
"rowguid": "532c3a9f-d684-40b4-a2e4-95c9846cd145",
"Disclaimer": "sample string 7",
"FromLocationId": "78ea55eb-28c8-4c6d-b983-eaf6d9acce23",
"ToLocationId": "d4ad3be3-aa10-4a5e-8847-ba5a904996ff",
"ChargeCards": [
{
"$ref": "4"
},
{
"$ref": "4"
}
]
},
"Company": {
"$ref": "2"
},
"Payments": [
{
"$id": "6",
"ID": "e9e6ae85-313a-4b20-8541-949c57577a55",
"TypeId": "d25b0872-120b-4688-be6a-9c427a649e39",
"Type": "sample string 2",
"AccountID": "86486fe6-1112-4362-ad68-10ebf2d6be69",
"Amount": 3.0,
"TicketId": "39fd7a68-0680-4f47-a7b3-883a7e673395",
"Coupons": 1,
"ItemId": "9b5a68c9-9869-4d35-8325-6bb6670a0640",
"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": "3f721042-9227-42f8-a01d-978dca7d3300",
"CouponId": "3ce20d3b-8d0f-4eb3-a4af-f2dcefe9c819",
"CouponNumber": "sample string 11",
"Deposit": true,
"Paylater": 1.1,
"ChargeCard": {
"$ref": "4"
},
"PaymentType": {
"$id": "7",
"Id": "9f47f04e-8f0e-4d17-9a31-e375b746f7ed",
"Type": "sample string 2",
"Description": "sample string 3",
"Display": "sample string 4",
"SortOrder": 5,
"CompanyId": "d217a3b6-da6a-4161-be00-17ec520fb801",
"ReconcileShow": true,
"Company": {
"$ref": "2"
},
"Payments": [
{
"$ref": "6"
},
{
"$ref": "6"
}
]
},
"Ticket": {
"$id": "8",
"ID": "5acae5d1-c3e0-4206-a750-aa8d77a124da",
"Number": "sample string 2",
"SaleDateTime": "2026-01-24T22:38:57Z",
"SellerID": "668d1976-5a03-440e-b2be-f90bb4ae32b8",
"BoardingTime": "2026-01-24T22:38:57Z",
"BoarderID": "8d81e972-9b8a-4920-8dfa-837922d607d2",
"Total": 1.0,
"WalletId": "d83de06c-230a-404a-bad2-56af36bc3320",
"LocationId": "ddf98f22-335f-45a2-9162-bc222b4e1b8b",
"PassengerId": "b1f5265c-7aac-4d2d-adaf-49a147b249ae",
"ReturnTime": "2026-01-24T22:38:57Z",
"ReturnBoarderId": "a1c1dae4-8155-4944-8757-7ac7656b4e99",
"Void": true,
"CompanyId": "46b4b747-fa79-4177-a618-50aa44a298ed",
"EntryTime": "2026-01-24T22:38:57Z",
"BoardingBoatId": "45bae4c9-75f6-4c4c-b71f-4b923f8026f9",
"BoardingLocationId": "cc66e675-450a-4f4b-b4d2-19cfdc953d1b",
"BoardingTripId": "9d681d7b-8498-4158-b1c6-ad8e3938159d",
"ReturnBoatId": "d19cf708-4215-4562-86a2-09b9616ccc43",
"ReturnLocationId": "2a3d2526-3854-43d2-bbe3-888678e904a6",
"ReturnTripId": "27ff459e-746c-467e-b972-828132b88cb8",
"roundtrip": true,
"HandHeldSaleNum": "sample string 6",
"ReservationItineraryId": "104a1c13-175c-437a-9475-621684b062b5",
"ReservationTripId": "4c216064-1def-46ee-b2e4-74fa78b83285",
"Cancelled": true,
"Stay": "sample string 8",
"InternalComments": "sample string 9",
"Memo": "sample string 10",
"CancellationUserId": "d5b71844-54bb-4752-ad87-912761061e30",
"FromLocationId": "9935218a-d223-4162-9ce3-4f2141d07bfc",
"ToLocationId": "f6ac94c4-8f9f-4aa4-84fd-a4e75495c196",
"CancelTime": "2026-01-24T22:38:57Z",
"CancellationUserId1": "2177348b-7e50-4756-a576-cd5cbf20b972",
"CancelTicketid": "f0f513f1-3922-4839-9ad3-55d495b72d88",
"CancelAmount": 1.0,
"Edit": 1,
"RefundAmount": 1.1,
"LineItems": [
{
"$id": "9",
"ID": "f0c139d6-1f88-4283-8f5a-686247f2dbd9",
"TicketID": "b5d50b90-ef72-4edf-bbd4-37dc3653b580",
"Number": 3,
"Description": "sample string 4",
"Qty": 5.1,
"Total": 6.1,
"ItemID": "d8bc2362-b33a-4d5e-b251-f7dd31221d22",
"Discount": 1.1,
"Coupons": 1,
"CardId": "565370db-04d6-4728-bec9-94f3a77670f1",
"NewCardSale": true,
"GiftCertificateUsed": true,
"Item": {
"$id": "10",
"ID": "b4af150a-9f34-4a8a-89ec-def860d5ef99",
"ItemNumber": "sample string 2",
"ShortName": "sample string 3",
"Name": "sample string 4",
"Description": "sample string 5",
"ItemType": "45955a3c-2d77-4176-aa40-3d1aa0801eeb",
"SortOrder": 7,
"CompanyId": "cb22d8aa-60e6-4e47-a548-12dc1128a7dd",
"OneWayId": "7c7848ef-ad40-4cdb-87e0-a27f3e37b1f5",
"RoundTrip": true,
"InActive": true,
"CardPriceSheetId": "a5e23dde-52f2-449e-83c2-9c4c2f262032",
"TakesSeat": true,
"Groups": true,
"Expire": 1,
"Disclaimer": "sample string 12",
"quickbooksId": "cb3f8c59-8ab2-403b-8061-77a92675cd3f",
"Company": {
"$ref": "2"
},
"RoundTripItems": [
{
"$ref": "10"
},
{
"$ref": "10"
}
],
"OneWayItem": {
"$ref": "10"
},
"PriceSheet": {
"$id": "11",
"ID": "3b5d22fd-4350-4cc7-a4be-cf0635e88e63",
"Name": "sample string 2",
"Description": "sample string 3",
"CompanyId": "47a8ee25-d708-4cb7-b9a9-387fb0359d73",
"Basic": "sample string 5",
"StartDate": "2026-01-24T22:38:57Z",
"EndDate": "2026-01-24T22:38:57Z",
"Hierarchy": 6,
"Inactive": true,
"Company": {
"$ref": "2"
},
"Effectives": [
{
"$id": "12",
"EffectiveID": "c40779ae-1f3c-4525-b985-44e58cbd2722",
"PriceSheetID": "33da8e00-d402-42dd-a80f-be5a66238fc1",
"EffectiveDay": 1,
"EffectiveStartTime": "2026-01-24T22:38:57Z",
"EffectiveEndTime": "2026-01-24T22:38:57Z",
"Checked": "sample string 3",
"PriceSheet": {
"$ref": "11"
}
},
{
"$ref": "12"
}
],
"Items": [
{
"$ref": "10"
},
{
"$ref": "10"
}
],
"Prices": [
{
"$id": "13",
"ID": "2becaddb-d17b-4fa2-9fb6-3ae81b76ccec",
"PriceSheetId": "63f37aa0-74e1-4abe-a5ee-5bc58ba019c3",
"ItemId": "a3d0d6d9-870e-461a-b746-4404d8de8b7c",
"Price1": 4.0,
"StartDate": "2026-01-24T22:38:57Z",
"EndDate": "2026-01-24T22:38:57Z",
"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": "6ae4a2e5-284f-45a9-ba5b-5c999609d3a0",
"UsersId": "6ae4a2e5-284f-45a9-ba5b-5c999609d3a0",
"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": "8"
},
{
"$ref": "8"
}
],
"Users_UserPermissions": [
{
"$id": "15",
"Users_UserPermissionsId": "af171ce5-7da6-4fe8-8446-e282f3251908",
"UsersId": "0a1ed58a-c9bb-4af8-af79-23feebe1ae6c",
"PermissionsID": "f47a11cd-9cfe-49ef-a23a-62fffbdd2742",
"User": {
"$ref": "14"
}
},
{
"$ref": "15"
}
],
"AccountTransactions": [
{
"$id": "16",
"ID": "6b1fc61d-5509-4b9b-aa9e-84a8d46fd39a",
"TransactionDate": "2026-01-24T22:38:57Z",
"Amount": 3.0,
"Type": "sample string 4",
"ChargeAccountID": "956d81cf-7479-4ed2-8cb0-79e7a2fbe769",
"UserID": "2a8a0bde-9244-4755-9b24-2bee79b667f0",
"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": "ac485917-8424-4269-b41e-d4d3c136e963",
"RoleId": "b4461504-0c56-41d0-a3fa-390f35f9f6e1",
"TerminationDate": "2026-01-24T22:38:57Z",
"rowguid": "81b31a8d-2cb2-4a38-89a0-a192870982f7",
"User": {
"$ref": "14"
}
},
{
"$ref": "18"
}
],
"CompanyUsers": [
{
"$id": "19",
"CompanyUserId": "992ebedf-d7fd-49c0-8146-e6728b3c4d03",
"CompanyId": "708a7784-624f-4828-a17b-fc22ac2db170",
"UsersId": "5f63db29-87ec-4881-8db4-a7578831a2ff",
"UserNumber": "sample string 3",
"StartDate": "2026-01-24T22:38:57Z",
"TerminationDate": "2026-01-24T22:38:57Z",
"Company": {
"$ref": "2"
},
"User": {
"$ref": "14"
}
},
{
"$ref": "19"
}
]
},
"Location": {
"$ref": "1"
},
"Wallet": {
"$id": "20",
"id": "d5eaef3a-99b5-4bbd-a371-92bd50bfd627",
"Name": "sample string 2",
"companyId": "525d7c00-6aa0-468b-8546-b3708c4bbdc6",
"shortName": "sample string 4",
"BoatCrew": true,
"SortOrder": 1,
"Active": true,
"ReconcileShow": true,
"BoatId": "7a4627ae-5fcf-44b5-b4bf-1c8f376a5519",
"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": "2b095d45-1219-49e0-ab8e-d929d8d3c47f",
"deviceId": "e0aa53ad-9519-4db9-ab43-e8fcfa17b4ff",
"companyId": "6ada60a0-215a-42c2-a922-df9f31b26bac",
"voidDate": "2026-01-24T22:38:57Z",
"Company": {
"$ref": "2"
},
"Device": {
"$id": "22",
"id": "2657da36-b971-41ee-bd89-b092b466d6bb",
"deviceNumber": "sample string 2",
"deviceName": "sample string 3",
"deviceCompanies": [
{
"$ref": "21"
},
{
"$ref": "21"
}
]
}
},
{
"$ref": "21"
}
],
"Items": [
{
"$ref": "10"
},
{
"$ref": "10"
}
],
"ItemTypes": [
{
"$id": "23",
"ID": "a8c91cb5-5365-48cb-bd91-adc0ca68b6e1",
"ShortName": "sample string 2",
"Name": "sample string 3",
"Description": "sample string 4",
"CompanyId": "e4c46da8-20eb-4190-948a-4ec02143b3ef",
"Company": {
"$ref": "2"
}
},
{
"$ref": "23"
}
],
"Locations": [
{
"$ref": "1"
},
{
"$ref": "1"
}
],
"PaymentTypes": [
{
"$ref": "7"
},
{
"$ref": "7"
}
],
"PriceSheets": [
{
"$ref": "11"
},
{
"$ref": "11"
}
],
"Roles": [
{
"$id": "24",
"RoleId": "dba10626-c613-4b1e-829b-bbd0543207d2",
"CompanyId": "0ff728bf-b7d2-4612-b050-06a382070e3a",
"RoleName": "sample string 2",
"Active": true,
"DateRange": 1,
"PasswordChange": 1,
"Company": {
"$ref": "2"
},
"Role_Permissions": [
{
"$id": "25",
"RoleId": "3b48d82d-ba31-44f3-bd35-6911efb3be6f",
"PermissionsId": "e1a74076-9a76-4b32-9d73-bf5c08e11fa1",
"Role_PermissionsId": "10f8f5c0-3b5e-4c29-b003-82b8fd8ced03",
"Role": {
"$ref": "24"
}
},
{
"$ref": "25"
}
]
},
{
"$ref": "24"
}
],
"UserPermissions": [
{
"$id": "26",
"UserPermissionId": "f0606312-b95e-4dc2-bff5-74510456ae34",
"PermissionsId": "84ec3294-d36a-46dd-be0b-cfb076c11dbf",
"CompanyId": "36c72f00-e090-4956-bc91-0340dff2357f",
"ReadWrite": true,
"Company": {
"$ref": "2"
},
"Permission": {
"$id": "27",
"PermissionsId": "1384ef6f-102e-496e-b69a-b97215c851db",
"TypePermission": "sample string 2",
"Name": "sample string 3",
"Description": "sample string 4",
"parentId": "48ead46d-efc9-4b11-9265-0ebfaf8a53dc",
"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"
}
]