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": "74a916b5-ed3e-4d73-b9b2-c94dc29f980e",
"name": "sample string 2",
"abbr": "sample string 3",
"companyId": "b5b94437-6c4e-4051-a193-bea8437705bd",
"inactive": true,
"Company": {
"$id": "2",
"CompanyId": "6001b749-0f5c-4207-a1dc-65e62e694375",
"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": "7b4948bf-ff23-4160-8eb6-15036c21f677",
"QuickBooksFile": "sample string 10",
"email": "sample string 11",
"ChargeAccounts": [
{
"$id": "3",
"ID": "1c92ba73-cf9d-43e9-8825-7c1eb7c2e6cd",
"Name": "sample string 2",
"CompanyId": "3237f026-a0a2-493d-837c-75835c924ac9",
"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": "1c3f7191-0ca2-47f6-8fec-6c26196ad353",
"Coupons": 1,
"CloseDate": "2026-09-21T10:56:45Z",
"AccountNumber": "sample string 15",
"Country": "sample string 16",
"FrequentlyUsed": true,
"SortOrder": 1,
"StartDate": "2026-09-21T10:56:45Z",
"InActive": true,
"Password": "sample string 17",
"Company": {
"$ref": "2"
},
"ChargeCards": [
{
"$id": "4",
"ID": "37963baa-5a3c-4a45-be1e-4239c9217e8c",
"CompanyId": "8b56fe02-f35b-436e-a22c-1c840a35f364",
"CardNumber": "sample string 3",
"ChargeAccountId": "d229a8b1-9128-4bc4-b281-5c3bbc6f8bde",
"VoidDate": "2026-09-21T10:56:45Z",
"PassengerID": "9c2d829e-405a-41d2-9450-812ba2aa6301",
"PriceSheetID": "a01433d1-5201-4204-af06-32351eb74ede",
"CardType": "sample string 4",
"VoidReason": "sample string 5",
"CardTypeId": "02b82851-eb5b-426d-b7d4-1ee588bcfa12",
"CardType1": {
"$id": "5",
"Id": "abd6a9fa-12f8-4ef7-b1ad-e7a099cad8d8",
"Type": "sample string 2",
"Description": "sample string 3",
"CardStyle": "sample string 4",
"PriceSheetId": "ce29741c-5e29-4487-9e3a-9cb6e926d427",
"ItemId": "85b41fcd-051a-48a9-873e-52d87159381f",
"Discount": true,
"companyId": "c8f78a09-749d-463d-82cd-04f236d5e33d",
"NewCardChargeId": "501a5774-817a-46c5-a0de-134a58e0c768",
"rowguid": "762b900f-190e-4af9-b4ac-9b580272d55a",
"Disclaimer": "sample string 7",
"FromLocationId": "c81ee6c7-5611-4b41-ae7e-2f04eef78daf",
"ToLocationId": "91d7c521-853d-4f80-a3ca-5b5e0b1f8b21",
"ChargeCards": [
{
"$ref": "4"
},
{
"$ref": "4"
}
]
},
"Company": {
"$ref": "2"
},
"Payments": [
{
"$id": "6",
"ID": "145b7aa6-cb57-4e0e-9757-496f5e7d1135",
"TypeId": "dc3ded63-65a4-47f0-bacc-7a69cddc23c5",
"Type": "sample string 2",
"AccountID": "9bce0b66-5232-4af7-851b-e1253abe2f3b",
"Amount": 3.0,
"TicketId": "c3198cf5-541b-4ed2-88d4-9f9804d63033",
"Coupons": 1,
"ItemId": "c1cada32-30de-4a20-bb73-9bcf870c67e2",
"CreditAuthorization": "sample string 5",
"CreditAuthorizationAmt": 1.0,
"CreditRefNumber": "sample string 6",
"Void": true,
"VoidDateTime": "2026-09-21T10:56:45Z",
"VoidAmt": 1.0,
"VoidRefNumber": "sample string 8",
"Returned": true,
"ReturnDateTime": "2026-09-21T10:56:45Z",
"ReturnAmt": 1.0,
"ReturnRefNumber": "sample string 10",
"CardId": "98eb7a87-9084-4e8d-99dd-bee3e65f71dd",
"CouponId": "3f4a4436-caa6-4dda-a789-47b56b3a3a3d",
"CouponNumber": "sample string 11",
"Deposit": true,
"Paylater": 1.1,
"ChargeCard": {
"$ref": "4"
},
"PaymentType": {
"$id": "7",
"Id": "8773136f-e602-4679-8324-6d72ad0cacc4",
"Type": "sample string 2",
"Description": "sample string 3",
"Display": "sample string 4",
"SortOrder": 5,
"CompanyId": "43af7b51-e755-407a-b056-89d0676599a9",
"ReconcileShow": true,
"Company": {
"$ref": "2"
},
"Payments": [
{
"$ref": "6"
},
{
"$ref": "6"
}
]
},
"Ticket": {
"$id": "8",
"ID": "d6b9b92f-8510-47b3-b583-c0971c17f181",
"Number": "sample string 2",
"SaleDateTime": "2026-09-21T10:56:45Z",
"SellerID": "b7bfb5c6-8f75-4f81-aa0f-60598d76da5a",
"BoardingTime": "2026-09-21T10:56:45Z",
"BoarderID": "d48292fa-0ec6-4ad5-9366-f567e9e65360",
"Total": 1.0,
"WalletId": "6a9087df-61c0-4ba3-8c09-b38a0b84fcf0",
"LocationId": "8f9bbd07-a5d7-48e8-b3a1-90d2454d8b03",
"PassengerId": "9bc7b68b-0503-4481-aec7-67e1a71c6cc3",
"ReturnTime": "2026-09-21T10:56:45Z",
"ReturnBoarderId": "5567ded8-f85c-428f-88a6-53d5f5791401",
"Void": true,
"CompanyId": "bef63429-9557-445f-bfa6-4b548c73de3c",
"EntryTime": "2026-09-21T10:56:45Z",
"BoardingBoatId": "22079b25-b783-4ccc-bc86-0c21c26468ac",
"BoardingLocationId": "06ddf650-01cb-4637-a336-5adfab756f9f",
"BoardingTripId": "1aabe05a-6f24-4825-95af-d5bc9e9df149",
"ReturnBoatId": "fc45a13c-48fc-4752-b0e2-dfd75e9baa20",
"ReturnLocationId": "58484e20-80a1-481b-a7eb-a82d06256041",
"ReturnTripId": "0f7b6edc-cf53-4d05-85f7-8ccd347c6ffb",
"roundtrip": true,
"HandHeldSaleNum": "sample string 6",
"ReservationItineraryId": "669b7ff8-01a2-4e14-9ee9-1e4cb9b94383",
"ReservationTripId": "8d9f232e-3d51-4077-ab1a-056ac000ef3b",
"Cancelled": true,
"Stay": "sample string 8",
"InternalComments": "sample string 9",
"Memo": "sample string 10",
"CancellationUserId": "8a65ae5a-6acf-493d-8554-7d3c9a4736d3",
"FromLocationId": "85b192f2-0475-4871-af5e-4a53145bd8df",
"ToLocationId": "e7ab8600-e577-4be4-b7c2-fbad579abba6",
"CancelTime": "2026-09-21T10:56:45Z",
"CancellationUserId1": "9923617f-9a52-46ea-beca-514ea7c29ce6",
"CancelTicketid": "9f2be5dc-6199-4dd3-84aa-3f11f82f8603",
"CancelAmount": 1.0,
"Edit": 1,
"RefundAmount": 1.1,
"LineItems": [
{
"$id": "9",
"ID": "52c46573-d695-4023-b746-8b481d710a5f",
"TicketID": "227c4888-a978-4d7d-8c3d-e89f7bec9172",
"Number": 3,
"Description": "sample string 4",
"Qty": 5.1,
"Total": 6.1,
"ItemID": "48ea9088-cbef-4d15-8a7f-d8aadb94eedf",
"Discount": 1.1,
"Coupons": 1,
"CardId": "cac2dbc8-f0d9-4664-9fee-4c87ec7e267c",
"NewCardSale": true,
"GiftCertificateUsed": true,
"Item": {
"$id": "10",
"ID": "8c20cece-2b11-4a75-bc52-ae5dbb33fb65",
"ItemNumber": "sample string 2",
"ShortName": "sample string 3",
"Name": "sample string 4",
"Description": "sample string 5",
"ItemType": "3ff4875a-c691-49da-b69b-be43ce54ad61",
"SortOrder": 7,
"CompanyId": "8cbf1ab2-0fd2-4f8f-bbfc-989a7625105f",
"OneWayId": "ec2819fa-6c69-47ec-9f33-08d1b186ad1e",
"RoundTrip": true,
"InActive": true,
"CardPriceSheetId": "796074cb-d644-4ad7-9f9a-7521ec4b9b18",
"TakesSeat": true,
"Groups": true,
"Expire": 1,
"Disclaimer": "sample string 12",
"quickbooksId": "1d5549f4-78bc-4c58-9168-2b9178f4d513",
"Company": {
"$ref": "2"
},
"RoundTripItems": [
{
"$ref": "10"
},
{
"$ref": "10"
}
],
"OneWayItem": {
"$ref": "10"
},
"PriceSheet": {
"$id": "11",
"ID": "42999012-6a1d-4fca-a6c6-3e2c988b8d30",
"Name": "sample string 2",
"Description": "sample string 3",
"CompanyId": "7632d18f-79d1-4430-967d-8cd8ae10d356",
"Basic": "sample string 5",
"StartDate": "2026-09-21T10:56:45Z",
"EndDate": "2026-09-21T10:56:45Z",
"Hierarchy": 6,
"Inactive": true,
"Company": {
"$ref": "2"
},
"Effectives": [
{
"$id": "12",
"EffectiveID": "0b6c7be1-584f-41de-b673-0aeecbfa11a1",
"PriceSheetID": "cc037265-ac8b-418a-a922-dc83ae59099a",
"EffectiveDay": 1,
"EffectiveStartTime": "2026-09-21T10:56:45Z",
"EffectiveEndTime": "2026-09-21T10:56:45Z",
"Checked": "sample string 3",
"PriceSheet": {
"$ref": "11"
}
},
{
"$ref": "12"
}
],
"Items": [
{
"$ref": "10"
},
{
"$ref": "10"
}
],
"Prices": [
{
"$id": "13",
"ID": "e8a2a2ab-55b2-438b-91b9-7761893de1ea",
"PriceSheetId": "35e9f2dc-d37e-49b9-8baf-a7c7a4bb090b",
"ItemId": "c78e555f-225c-460e-84bc-2441e941ef6d",
"Price1": 4.0,
"StartDate": "2026-09-21T10:56:45Z",
"EndDate": "2026-09-21T10:56:45Z",
"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": "b0105b32-1834-466e-a816-b98d572712c9",
"UsersId": "b0105b32-1834-466e-a816-b98d572712c9",
"UserName": "sample string 4",
"DateHired": "2026-09-21T10:56:45Z",
"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-09-21T10:56:45Z",
"inactive": true,
"Email": "sample string 19",
"AccessFailedCount": 1,
"EmailConfirmed": true,
"LockoutEnabled": true,
"LockoutEndDateUtc": "2026-09-21T10:56:45Z",
"PhoneNumberConfirmed": true,
"SecurityStamp": "sample string 20",
"TwoFactorEnabled": true,
"Tickets": [
{
"$ref": "8"
},
{
"$ref": "8"
}
],
"Users_UserPermissions": [
{
"$id": "15",
"Users_UserPermissionsId": "b8bb872b-1564-413c-8371-dbfe6800936e",
"UsersId": "00ed61e7-8b3e-4a8a-b522-3a999ab39096",
"PermissionsID": "8ea043cc-5b63-487e-a295-37779c74b7b5",
"User": {
"$ref": "14"
}
},
{
"$ref": "15"
}
],
"AccountTransactions": [
{
"$id": "16",
"ID": "bb0d1962-0803-4cb9-877f-27314b6247c0",
"TransactionDate": "2026-09-21T10:56:45Z",
"Amount": 3.0,
"Type": "sample string 4",
"ChargeAccountID": "4dab922f-c696-4705-a499-2f89475f4d10",
"UserID": "0d105319-46ac-4e33-8bd9-05bf0a2a4bff",
"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": "d9356151-28d4-4d7c-931f-88a848a3bb79",
"RoleId": "4ec11c9e-9a13-4599-a3b7-a8bb10b4451a",
"TerminationDate": "2026-09-21T10:56:45Z",
"rowguid": "14bf5552-ebfc-45e8-9e1c-8e2d832f25d3",
"User": {
"$ref": "14"
}
},
{
"$ref": "18"
}
],
"CompanyUsers": [
{
"$id": "19",
"CompanyUserId": "31b36a25-b861-4290-884e-0feac186ec86",
"CompanyId": "93d9a8a2-1a87-47a8-9cf3-2a76e4c124c1",
"UsersId": "f903272b-ae67-487a-b0a9-e5386cf11352",
"UserNumber": "sample string 3",
"StartDate": "2026-09-21T10:56:45Z",
"TerminationDate": "2026-09-21T10:56:45Z",
"Company": {
"$ref": "2"
},
"User": {
"$ref": "14"
}
},
{
"$ref": "19"
}
]
},
"Location": {
"$ref": "1"
},
"Wallet": {
"$id": "20",
"id": "7abf6341-e183-4e5e-96d9-38882090347e",
"Name": "sample string 2",
"companyId": "72ec1e61-2ee7-4b89-b0cd-7e6c17987da8",
"shortName": "sample string 4",
"BoatCrew": true,
"SortOrder": 1,
"Active": true,
"ReconcileShow": true,
"BoatId": "9cfad6ee-8bfe-4988-b371-e0e722f4e7e0",
"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": "4e06e317-11e4-47f8-97b6-0467245b6c0f",
"deviceId": "7757636b-469e-4e2d-b020-dd62cb89d543",
"companyId": "e491fd8d-600b-4f2f-88f4-136034848771",
"voidDate": "2026-09-21T10:56:45Z",
"Company": {
"$ref": "2"
},
"Device": {
"$id": "22",
"id": "6f04b91d-e03d-40bd-ac5b-0ba2ccae5b92",
"deviceNumber": "sample string 2",
"deviceName": "sample string 3",
"deviceCompanies": [
{
"$ref": "21"
},
{
"$ref": "21"
}
]
}
},
{
"$ref": "21"
}
],
"Items": [
{
"$ref": "10"
},
{
"$ref": "10"
}
],
"ItemTypes": [
{
"$id": "23",
"ID": "8774472e-0596-42ec-a51f-84b6e1301293",
"ShortName": "sample string 2",
"Name": "sample string 3",
"Description": "sample string 4",
"CompanyId": "db303a24-35e2-4ead-a0a3-6974d9eda58c",
"Company": {
"$ref": "2"
}
},
{
"$ref": "23"
}
],
"Locations": [
{
"$ref": "1"
},
{
"$ref": "1"
}
],
"PaymentTypes": [
{
"$ref": "7"
},
{
"$ref": "7"
}
],
"PriceSheets": [
{
"$ref": "11"
},
{
"$ref": "11"
}
],
"Roles": [
{
"$id": "24",
"RoleId": "6a349735-2fb5-4c25-b899-bfe6c3372dc7",
"CompanyId": "318982aa-215d-4146-b630-c63a168cdeab",
"RoleName": "sample string 2",
"Active": true,
"DateRange": 1,
"PasswordChange": 1,
"Company": {
"$ref": "2"
},
"Role_Permissions": [
{
"$id": "25",
"RoleId": "9be16057-b2ef-4afc-a7c5-f0d8d865465a",
"PermissionsId": "f6ac0365-abcd-414e-9a6e-3a10774685e4",
"Role_PermissionsId": "c1817ee8-888e-4dcc-95a1-111fd51828b0",
"Role": {
"$ref": "24"
}
},
{
"$ref": "25"
}
]
},
{
"$ref": "24"
}
],
"UserPermissions": [
{
"$id": "26",
"UserPermissionId": "06f09d1c-9fce-440a-854a-569b980509f8",
"PermissionsId": "2ce77cde-4785-43fc-9bc8-7230734b6bc1",
"CompanyId": "9f7fae1b-7775-48ce-a33d-da630476615f",
"ReadWrite": true,
"Company": {
"$ref": "2"
},
"Permission": {
"$id": "27",
"PermissionsId": "13c2840b-4a38-463b-adc7-d23e8ffe8fd8",
"TypePermission": "sample string 2",
"Name": "sample string 3",
"Description": "sample string 4",
"parentId": "0b58b733-90af-49ae-be12-686b8367bf2b",
"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"
}
]