Venue
APIs for managing and retrieving venue and venue unit information.
Retrieves a list of venues matching the provided filters. Returns detailed information for each venue, including address, support contacts, shopping cart settings, and daily report statistics.
The access token for the network operator admin session.
Optional. Filter by city.
Optional. Filter by state.
Optional. Filter by ISO 3166-1 alpha-3 country code.
Optional. Filter by postal code.
Optional. Filter by external venue ID.
POST /preview/networkoperatorconsole/venues/listVenues HTTP/1.1
Host: api.wifikey.io
Content-Type: application/json
Accept: */*
Content-Length: 135
{
"AccessToken": "{{NetworkOperatorAdmin-AccessToken}}",
"City": "",
"State": "",
"Country.ISO3166A3": "",
"PostalCode": "",
"externalVenueID": ""
}List of venues returned successfully.
{
"VenueList": {
"USA.SAMPLE.12345.SAMPLEPROPERTY.SAMPLECITY._V3VENUE.USA.MA.54321.TESTUNIT.SAMPLETOWN2": {
"dateAddedUTC.ISO8601": "2024-07-02T22:32:09.429Z",
"VenueID": "USA.SAMPLE.12345.SAMPLEPROPERTY.SAMPLECITY._V3VENUE.USA.MA.54321.TESTUNIT.SAMPLETOWN2",
"externalVenueID": "",
"VenueName": "1 Test Venue",
"AddressLine1": "1 Main St.",
"AddressLine2": "sfsdfsdf",
"City": "SAMPLETOWN2",
"State": "MA",
"Country": "USA",
"Country.ISO3166A3": "USA",
"PostalCode": "54321",
"SupportPhoneNumber.E164": "+10000000001",
"SupportEmailAddress": "[email protected]",
"TZ": "America/New_York",
"TimeZoneOffset": -4,
"TimeZone": -4,
"PropertyManagementGroupID": "USA.SAMPLE.12345.SAMPLEPROPERTY.SAMPLECITY",
"FCCLabel": {
"displayLabel": true,
"TypicalLatency": 100
},
"DisplayOptionID": "USA.MA.12345.ROAMINIQDEMO.SAMPLETOWN3._V3DISPLAY_.Venue Specific",
"DailyReport": {
"dateSnapshotGeneratedUTC.ISO8601": "2025-06-13T19:15:09.511Z",
"UnitCount_GlobalWirelessPlusLocalWiredAccess": 255,
"UnitCount_LocalWirelessAccess": 1,
"UnitCount_GlobalWirelessRoaming": 0,
"PolicyCount_GlobalWirelessPlusLocalWiredAccess": 113,
"PolicyCount_LocalWirelessAccess": 3,
"DeviceCount": 0,
"OnlineDeviceCount": 0
}
}
},
"VenueCount": 61,
"UnitCount_GlobalWirelessPlusLocalWiredAccess": 6555,
"UnitCount_LocalWirelessAccess": 34,
"UnitCount_GlobalWirelessRoaming": 0,
"PolicyCount_GlobalWirelessPlusLocalWiredAccess": 351,
"PolicyCount_LocalWirelessAccess": 9,
"DeviceCount": 27,
"OnlineDeviceCount": 8,
"errorProcessing": false
}Retrieves detailed information about a specific venue, including address, configuration, shopping cart, service plans, contacts, and unit structure. The response is keyed by VenueID and includes all venue configuration and status fields.
The access token for the network operator admin session.
The unique identifier for the venue.
POST /preview/networkoperatorconsole/venues/listVenueDetails HTTP/1.1
Host: api.wifikey.io
Content-Type: application/json
Accept: */*
Content-Length: 78
{
"AccessToken": "{{NetworkOperatorAdmin-AccessToken}}",
"VenueID": "{{VenueID}}"
}Venue details returned successfully.
{
"message": "",
"USA.SAMPLE.12345.SAMPLEPROPERTY.SAMPLECITY._V3VENUE.GBR.HEF.SG12DX.SAMPLEOFFICE.SAMPLETOWN": {
"dateAddedUTC.ISO8601": "2023-04-13T21:15:24.008Z",
"VenueID": "USA.SAMPLE.12345.SAMPLEPROPERTY.SAMPLECITY._V3VENUE.GBR.HEF.SG12DX.SAMPLEOFFICE.SAMPLETOWN",
"externalVenueID": "",
"NAS-Identifier": "GBR.HEF.SG12DX.SAMPLEOFFICE.SAMPLETOWN",
"VenueName": "WestEnd WiFi 2",
"DisplayOptionID": "USA.MA.12345.ROAMINIQDEMO.SAMPLETOWN3._V3DISPLAY_.default",
"AddressLine1": "Business & Technology Center",
"AddressLine2": "Bessemer Drive Suite 2",
"City": "SAMPLETOWN",
"State": "HER",
"Country.ISO3166A3": "GBR",
"PostalCode": "SG1 2DX",
"TZ": "Europe/London",
"TimeZoneOffset": 1,
"TimeZone": 1,
"FCCLabel": {
"displayLabel": false,
"TypicalLatency": -1
},
"RealPagePMCId": "",
"RealPageSiteId": "",
"enableRealPageSync": false,
"RealPageSyncDateTimeUTC.ISO8601": "",
"ShoppingCart": {
"Currencies": [
"USD",
"GBP"
],
"enableShoppingCart": true,
"StripePublishableKey": "",
"StripeWebHookURL": "https://api.wifikey.io/preview/networkoperatorconsole/shoppingcart/stripepayment?stripeop=operator",
"Stripe_allowrefund": "",
"ShoppingCartPriceAdjustment.USD": 0,
"ShoppingCartPriceAdjustment.GBP": 0,
"hasVenueUnitShoppingCartPriceAdjustment": true,
"singleuseVenueUnitPriceAdjustment": false,
"TrialCycleAdjustment": 0
},
"DeviceCount": 0,
"DisplayConfiguration": {
"ThemeLight": {
"LogoFileNameDesktopLogin": "/roamingiq/roamingiq-logo.png"
},
"ThemeDark": {
"LogoFileNameDesktopLogin": "/roamingiq/roamingiq-logo.png"
},
"MetaData": {
"FavIconHRef": "/roamingiq/roamingIQ-favicon.png?v=3"
},
"Behavior": {
"CancellationMethod": "radio"
},
"ShoppingCart": {
"enableShoppingCart": true
},
"Support": {
"ShowSupportLinks": true
}
},
"PrimaryContactGivenName": "Test",
"PrimaryContactName": "Test Contact",
"PrimaryContactFamilyName": "Contact",
"PrimaryContactEmailAddress": "[email protected]",
"SupportEmailAddress": "[email protected]",
"PrimaryContactPhoneNumber.E164": "+10000000003",
"SupportPhoneNumber.E164": "+10000000003",
"VenueType": "WIRED+WIFI",
"WelcomeEmail_countdown_hours": 0,
"sendSubscriptionAddedEmail": true,
"sendSubscriptionEndEmail": false,
"ReportingSubscriptionEnd_lookahead_hours": 720,
"ReportingSubscriptionEnd_frequency_hours": 720,
"DefaultSubscriptionDurationHours_GlobalWirelessPlusLocalWiredAccess": 0,
"DefaultSubscriptionDurationHours_LocalWirelessAccess": 0,
"DefaultServicePlanID_GlobalWirelessPlusLocalWiredAccess": "USA.MA.12345.ROAMINIQDEMO.SAMPLETOWN3._V3SERVICEPLAN_.1GBPSBULK",
"DefaultServicePlanID_LocalWirelessAccess": "USA.MA.12345.ROAMINIQDEMO.SAMPLETOWN3._V3SERVICEPLAN_.24HRFREEPLAN",
"allowOverlappingSubscriptionWiredUnit": false,
"MinimumAutoGeneratedVLAN_GlobalWirelessPlusLocalWiredAccess": 1,
"MaximumAutoGeneratedVLAN_GlobalWirelessPlusLocalWiredAccess": 4000,
"MinimumAutoGeneratedVLAN_LocalWirelessAccess": 1,
"MaximumAutoGeneratedVLAN_LocalWirelessAccess": 4000,
"MinimumAutoGeneratedVLAN_GlobalWirelessRoaming": 1,
"MaximumAutoGeneratedVLAN_GlobalWirelessRoaming": 4000,
"VenueAdministrators": [
"[email protected]"
],
"LeasingAgents": "",
"Integrations": {
"ConnectWise": {
"URL": ""
},
"PRTG": {
"URL": ""
}
},
"PropertyManagementGroup": {
"PropertyManagementGroupID": "USA.SAMPLE.12345.SAMPLEPROPERTY.SAMPLECITY",
"PropertyManagementGroupName": "RoamingIQ Demo Managed Properties"
},
"NetworkOperatorConnections": {
"USA.MA.12345.ROAMINIQDEMO.SAMPLETOWN3": {
"NetworkOperatorName": "RoamingIQ Demo"
}
},
"Keypools": {
"USA.MA.12345.ROAMINIQDEMO.SAMPLETOWN3._V3SSID.VAULT.global": {
"ssid": "VAULT",
"Scope": "global",
"DisplayOrder": 50,
"currentKeypoolStatus": "Operational"
},
"USA.MA.12345.ROAMINIQDEMO.SAMPLETOWN3._V3SSID.Customer.global": {
"ssid": "Customer",
"Scope": "global",
"DisplayOrder": 40,
"currentKeypoolStatus": "Operational"
}
},
"CoreEquipmentStatus": {},
"CoreEquipmentCount": 0,
"CoreEquipmentUPCount": 0,
"AvailableServicePlans": [
{
"ServicePlanID": "USA.MA.12345.ROAMINIQDEMO.SAMPLETOWN3._V3SERVICEPLAN_.1GBPSBULK"
}
],
"PendingAUP": 0,
"RecentlyStartedSubscriptionsList_7day": {},
"UpcomingSubscriptionStartCount_1day": 0,
"UpcomingSubscriptionsList_1day": {},
"UpcomingSubscriptionStartCount_7day": 0,
"UpcomingSubscriptionsList_7day": {},
"UpcomingSubscriptionEndList_7day_unconfirmed": {},
"UpcomingSubscriptionEndCount_14day": 0,
"UpcomingSubscriptionEndList_14day": {},
"UpcomingGuestSubscriptionEndCount_14day": 0,
"UpcomingGuestSubscriptionEndList_14day": {},
"UnitsWithSubscriptionsCount": 0,
"Units-Building-Floor-List-Subscribers": {
"101": {
"1": {
"1": {
"UnitID_internal": "USA.SAMPLE.12345.SAMPLEPROPERTY.SAMPLECITY._V3VENUE.GBR.HEF.SG12DX.SAMPLEOFFICE.SAMPLETOWN.101.1.1"
}
}
}
},
"Units-Building-Floor-List-GuestNetworks": {
"Guest-1": {
"1": {
"1": {
"UnitID_internal": "USA.SAMPLE.12345.SAMPLEPROPERTY.SAMPLECITY._V3VENUE.GBR.HEF.SG12DX.SAMPLEOFFICE.SAMPLETOWN.GUEST-1.1.1"
}
}
}
},
"Units-Building-Floor-List-RoamingNetworks": {},
"Subscriptions": {},
"GuestSubscriptions": {},
"UnitsWithoutSubscriptionsCount": 42
},
"errorProcessing": false
}Retrieves the activity or change log for a specific venue.
The access token for the network operator admin session.
The unique identifier for the venue.
POST /preview/networkoperatorconsole/venues/listVenueLog HTTP/1.1
Host: api.wifikey.io
Content-Type: application/json
Accept: */*
Content-Length: 115
{
"AccessToken": "{{NetworkOperatorAdmin-AccessToken}}",
"VenueID": "USA.MA.67890.Customer.SAMPLETOWN4._V3VENUE.12345"
}{
"message": "",
"UnitID_internal": "USA.VA.22102.CustomerMANAGEDPROPERTIES.City._V3VENUE.USA.MA.02140.PROPERTY.CITY.105.1.DEFAULT",
"log": [
{
"dateAddedUTC.ISO8601": "2025-02-25T17:51:25.741Z",
"function_name": "vault_networkoperator_equipmentConfigurator",
"event": {
"Command": "modify",
"PORT": 1008,
"ChangeAuthStatus": "SUCCESS",
"PortSpeedStatus": "SUCCESS",
"Request": "Enable port USA.VA.22102.CustomerMANAGEDPROPERTIES.City._V3VENUE.USA.MA.02140.PROPERTY.CITY.105.1.DEFAULT(VLAN: 1008) for 1000000 DOWN/1000000 UP. "
},
"SourceIP": "",
"UnitID_internal": [
"USA.VA.22102.CustomerMANAGEDPROPERTIES.City._V3VENUE.USA.MA.02140.PROPERTY.CITY.105.1.DEFAULT"
],
"VenueID": ""
},
{
"dateAddedUTC.ISO8601": "2025-02-25T17:51:16.260Z",
"function_name": "vault_networkoperator_equipmentConfigurator",
"event": {
"Command": "modify",
"PORT": 1008,
"ChangeAuthStatus": "SUCCESS",
"PortSpeedStatus": "SUCCESS",
"Request": "Enable port USA.VA.22102.CustomerMANAGEDPROPERTIES.City._V3VENUE.USA.MA.02140.PROPERTY.CITY.105.1.DEFAULT(VLAN: 1008) for 1000000 DOWN/1000000 UP. "
},
"SourceIP": "",
"UnitID_internal": [
"USA.VA.22102.CustomerMANAGEDPROPERTIES.City._V3VENUE.USA.MA.02140.PROPERTY.CITY.105.1.DEFAULT"
],
"VenueID": ""
},
{
"dateAddedUTC.ISO8601": "2025-02-25T17:50:36.801Z",
"function_name": "vault_venuemgmtconsole_addSubscriber_stripe",
"event": {
"message": "Added subscription at USA.VA.22102.CustomerMANAGEDPROPERTIES.City._V3VENUE.USA.MA.02140.PROPERTY.CITY.105.1.DEFAULT for Token.********* (105-DEFAULT-1-327) starting 2025-02-25T17:50:35.362Z, ending 2026-02-26T04:59:59.999Z"
},
"Administrator": "[email protected]",
"SourceIP": "203.0.113.42",
"SourceLocale": "en-us",
"UnitID_internal": [
"USA.VA.22102.CustomerMANAGEDPROPERTIES.City._V3VENUE.USA.MA.02140.PROPERTY.CITY.105.1.DEFAULT"
],
"VenueID": ""
}
],
"errorProcessing": false
}Retrieves detailed information about a specific unit within a venue.
The access token for the network operator admin session.
The unique internal identifier for the unit.
POST /preview/networkoperatorconsole/venues/listVenueUnitDetails HTTP/1.1
Host: api.wifikey.io
Content-Type: application/json
Accept: */*
Content-Length: 94
{
"AccessToken": "{{NetworkOperatorAdmin-AccessToken}}",
"UnitID_internal": "{{UnitID_internal}}"
}Venue unit details returned successfully.
{
"message": "Found 1 units. ",
"VenueUnits": [
{
"UnitID_internal": "USA.VA.22102.CustomerMANAGEDPROPERTIES.City._V3VENUE.USA.MA.02140.PROPERTY.CITY.105.1.DEFAULT",
"externalVenueUnitID": "",
"vlan": 1008,
"purpose": "wiredunit",
"dateAddedUTC.ISO8601": "2024-09-23T19:13:19.960Z",
"UnitID": "105",
"UnitBuilding": "1",
"UnitFloor": "DEFAULT",
"AddressLine1": "160 Cambridge Park Drive",
"AddressLine2": "",
"City": "Cambridge",
"State": "MA",
"Country.ISO3166A3": "USA",
"PostalCode": "2140",
"Currency": "USD",
"CurrencySymbol": "$",
"RealPageUnitID": "",
"RealPageSyncDateTimeUTC.ISO8601": "",
"SMSCode": "",
"enableShoppingCart": "Inherit",
"ShoppingCartPriceAdjustment": 0,
"singleuseVenueUnitPriceAdjustment": "",
"Venue": {
"VenueID": "USA.VA.22102.CustomerMANAGEDPROPERTIES.City._V3VENUE.USA.MA.02140.PROPERTY.CITY.105",
"externalVenueID": "",
"Name": "Windsor at Cambridge Park",
"AddressLine1": "160 Cambridge Park Dr",
"AddressLine2": "",
"City": "Cambridge",
"State": "MA",
"Country.ISO3166A3": "USA",
"PostalCode": "02140",
"TZ": "America/New_York",
"TimeZone": -4,
"TimeZoneOffset": -4,
"Keypools": {
"USA.VA.22102.Customer.City._V3SSID.VAULT.global": {
"ssid": "VAULT",
"Scope": "global",
"DisplayOrder": 50,
"currentKeypoolStatus": "Operational"
},
"USA.VA.22102.Customer.City._V3SSID.Customer.global": {
"ssid": "Customer",
"Scope": "global",
"DisplayOrder": 40,
"currentKeypoolStatus": "Operational"
}
}
},
"Subscriptions": {
"USA.VA.22102.CustomerMANAGEDPROPERTIES.City._V3VENUE.USA.MA.02140.PROPERTY.CITY.105.1.DEFAULT.Token.2025-02-25T17:50:35.362Z.2026-02-26T04:59:59.999Z": {
"SubscriberToken": "Token",
"externalSubscriberID": "",
"externalSubscriptionID": "sample-ext-sub-id-abcd-efgh12345678",
"StartDateTimeUTC.ISO8601": "2025-02-25T17:50:35.362Z",
"StripeClientSecret": "seti_SAMPLE123456789_secret_SampleSecretKey123456789",
"paymentFailed": false,
"RealPageSyncDateTimeUTC.ISO8601": "",
"ServicePlan": {
"ServicePlanID": "USA.VA.22102.Customer.City._V3SERVICEPLAN_.1GIGX1GIG",
"ServicePlanName": "1GIG x 1GIG",
"ServicePlanDescription": "1 Gbps billed monthly. Blazing fast internet speed. Perfect for 10+ devices.",
"externalServicePlanID": "1x1 Gbps (Monthly)",
"BillingCycleHours": 730.5,
"DownloadKbps": 1000000,
"UploadKbps": 1000000
},
"Status": "In Service",
"SubscriberEmail": "[email protected]",
"contactpref_sms": false,
"contactpref_email": true,
"SubscriberLocale": "en-us",
"SubscriberGivenName": "Teresa",
"SubscriberFamilyName": "LaCroce",
"SubscriberPhoneNumber.E164": "+12345678902",
"EndDateTimeUTC.ISO8601": "2026-02-26T04:59:59.999Z",
"ConfirmedEndDate.ISO8601": "",
"ListBillingCyclePrice": 10000,
"VenueUnitPriceAdjustment": 0,
"VenuePriceAdjustment": -10000
}
},
"GuestSubscriptions": {},
"AvailableServicePlans": {
"USA.VA.22102.Customer.City._V3SERVICEPLAN_.1GIGX1GIG": {
"ServicePlanName": "1GIG x 1GIG",
"ServicePlanDescription": "1 Gbps billed monthly. Blazing fast internet speed. Perfect for 10+ devices.",
"externalServicePlanID": "1x1 Gbps (Monthly)",
"ServicePlanImageURL": "https://domain/ui.us-east-1.wifikey.io/Customer/plan3.png",
"DownloadKbps": 1000000,
"UploadKbps": 1000000,
"GloballyAvailablePlan": false,
"ConcurrentDevices": 100,
"BillingCycleHours": 730.5,
"BillingCyclePrice.USD": 10000,
"MaximumTrialCyclesPerSubscriberPerVenue": 1,
"MaximumFreeEnrollmentsPerSubscriberPerVenue": 0,
"TrialCycles": 0,
"SessionTimeoutSecondsPerDevice": 3600
},
"USA.VA.22102.Customer.City._V3SERVICEPLAN_.1GIGX1GIGBULK": {
"ServicePlanName": "1GIG x 1GIG Bulk",
"ServicePlanDescription": "1GIG x 1GIG Bulk",
"externalServicePlanID": "",
"ServicePlanImageURL": "https://domain/moreURLimages/plan1.png",
"DownloadKbps": 1000000,
"UploadKbps": 1000000,
"GloballyAvailablePlan": false,
"ConcurrentDevices": 100,
"BillingCycleHours": 730.5,
"BillingCyclePrice.USD": 0,
"MaximumTrialCyclesPerSubscriberPerVenue": 0,
"MaximumFreeEnrollmentsPerSubscriberPerVenue": 0,
"TrialCycles": 0,
"SessionTimeoutSecondsPerDevice": 3600
},
"USA.VA.22102.Customer.City._V3SERVICEPLAN_.EMERGENCYSERVICE": {
"ServicePlanName": "Emergency Service",
"ServicePlanDescription": "28kbps Emergency Service",
"externalServicePlanID": "",
"ServicePlanImageURL": "",
"DownloadKbps": 28,
"UploadKbps": 28,
"GloballyAvailablePlan": true,
"ConcurrentDevices": 100,
"BillingCycleHours": 730.5,
"BillingCyclePrice.USD": 0,
"MaximumTrialCyclesPerSubscriberPerVenue": 0,
"MaximumFreeEnrollmentsPerSubscriberPerVenue": 0,
"TrialCycles": 0,
"SessionTimeoutSecondsPerDevice": 3600
}
}
}
],
"errorProcessing": false
}Retrieves the activity or change log for a specific unit within a venue.
The access token for the network operator admin session.
The unique internal identifier for the unit.
POST /preview/networkoperatorconsole/venues/listVenueUnitLog HTTP/1.1
Host: api.wifikey.io
Content-Type: application/json
Accept: */*
Content-Length: 94
{
"AccessToken": "{{NetworkOperatorAdmin-AccessToken}}",
"UnitID_internal": "{{UnitID_internal}}"
}{
"message": "",
"UnitID_internal": "USA.VA.22102.CustomerMANAGEDPROPERTIES.City._V3VENUE.USA.MA.02140.PROPERTY.CITY.105.1.DEFAULT",
"log": [
{
"dateAddedUTC.ISO8601": "2025-02-25T17:51:25.741Z",
"function_name": "vault_networkoperator_equipmentConfigurator",
"event": {
"Command": "modify",
"PORT": 1008,
"ChangeAuthStatus": "SUCCESS",
"PortSpeedStatus": "SUCCESS",
"Request": "Enable port USA.VA.22102.CustomerMANAGEDPROPERTIES.City._V3VENUE.USA.MA.02140.PROPERTY.CITY.105.1.DEFAULT(VLAN: 1008) for 1000000 DOWN/1000000 UP. "
},
"SourceIP": "",
"UnitID_internal": [
"USA.VA.22102.CustomerMANAGEDPROPERTIES.City._V3VENUE.USA.MA.02140.PROPERTY.CITY.105.1.DEFAULT"
],
"VenueID": ""
},
{
"dateAddedUTC.ISO8601": "2025-02-25T17:51:16.260Z",
"function_name": "vault_networkoperator_equipmentConfigurator",
"event": {
"Command": "modify",
"PORT": 1008,
"ChangeAuthStatus": "SUCCESS",
"PortSpeedStatus": "SUCCESS",
"Request": "Enable port USA.VA.22102.CustomerMANAGEDPROPERTIES.City._V3VENUE.USA.MA.02140.PROPERTY.CITY.105.1.DEFAULT(VLAN: 1008) for 1000000 DOWN/1000000 UP. "
},
"SourceIP": "",
"UnitID_internal": [
"USA.VA.22102.CustomerMANAGEDPROPERTIES.City._V3VENUE.USA.MA.02140.PROPERTY.CITY.105.1.DEFAULT"
],
"VenueID": ""
},
{
"dateAddedUTC.ISO8601": "2025-02-25T17:50:36.801Z",
"function_name": "vault_venuemgmtconsole_addSubscriber_stripe",
"event": {
"message": "Added subscription at USA.VA.22102.CustomerMANAGEDPROPERTIES.City._V3VENUE.USA.MA.02140.PROPERTY.CITY.105.1.DEFAULT for Token.********* (105-DEFAULT-1-327) starting 2025-02-25T17:50:35.362Z, ending 2026-02-26T04:59:59.999Z"
},
"Administrator": "[email protected]",
"SourceIP": "203.0.113.42",
"SourceLocale": "en-us",
"UnitID_internal": [
"USA.VA.22102.CustomerMANAGEDPROPERTIES.City._V3VENUE.USA.MA.02140.PROPERTY.CITY.105.1.DEFAULT"
],
"VenueID": ""
}
],
"errorProcessing": false
}Retrieves usage data (e.g., bandwidth, device count) for a specific unit within a venue.
The access token for the network operator admin session.
The unique identifier for the unit.
POST /preview/networkoperatorconsole/venues/listVenueUnitUsageData HTTP/1.1
Host: api.wifikey.io
Content-Type: application/json
Accept: */*
Content-Length: 74
{
"AccessToken": "{{NetworkOperatorAdmin-AccessToken}}",
"UnitID": "UNIT-001"
}Usage data for the unit returned successfully.
{
"message": "",
"UsageData": [
{
"ReportingTimestamp": "2025-06-10T04:00:00.000Z",
"UsageReportDateUTC.ISO8601": "2025-06-10T04:00:00.000Z",
"Acct-Input-Octets": 2819185243,
"Acct-Output-Octets": 13555815709,
"Acct-Total-Octets": 16375000952
},
{
"ReportingTimestamp": "2025-06-11T04:00:00.000Z",
"UsageReportDateUTC.ISO8601": "2025-06-11T04:00:00.000Z",
"Acct-Input-Octets": 424854235,
"Acct-Output-Octets": 7839462000,
"Acct-Total-Octets": 8264316235
},
{
"ReportingTimestamp": "2025-06-12T04:00:00.000Z",
"UsageReportDateUTC.ISO8601": "2025-06-12T04:00:00.000Z",
"Acct-Input-Octets": 89893533,
"Acct-Output-Octets": 7636540009,
"Acct-Total-Octets": 7726433542
},
{
"ReportingTimestamp": "2025-06-13T04:00:00.000Z",
"UsageReportDateUTC.ISO8601": "2025-06-13T04:00:00.000Z",
"Acct-Input-Octets": 198524302,
"Acct-Output-Octets": 15450730599,
"Acct-Total-Octets": 15649254901
}
],
"errorProcessing": false
}Retrieves 24 hour usage data (e.g., total bandwidth, total device count) for a specific venue.
The access token for the network operator admin session.
The unique identifier for the venue.
The start date (UTC, ISO8601) for the usage report.
POST /preview/networkoperatorconsole/venues/listVenueUsageData HTTP/1.1
Host: api.wifikey.io
Content-Type: application/json
Accept: */*
Content-Length: 139
{
"AccessToken": "{{NetworkOperatorAdmin-AccessToken}}",
"VenueID": "{{VenueID}}",
"UsageReportStartDateUTC.ISO8601": "2025-06-11T06:00:00.000Z"
}Usage data for the venue returned successfully.
{
"message": "",
"UsageData": [
{
"UnitID_internal": "USA.VA.22102.CustomerMANAGEDPROPERTIES.City._V3VENUE.USA.DC.20005.Address.City.816.1.1",
"UnitID": "816",
"UnitBuilding": "1",
"UnitFloor": "1",
"UsageReportDateUTC.ISO8601": "2025-06-12T03:59:59.999Z",
"Acct-Input-Octets": 123595081,
"Acct-Output-Octets": 1986332919,
"Acct-Total-Octets": 2109928000
},
{
"UnitID_internal": "USA.VA.22102.CustomerMANAGEDPROPERTIES.City._V3VENUE.USA.DC.20005.Address.City.912.1.1",
"UnitID": "912",
"UnitBuilding": "1",
"UnitFloor": "1",
"UsageReportDateUTC.ISO8601": "2025-06-12T03:59:59.999Z",
"Acct-Input-Octets": 2380916397,
"Acct-Output-Octets": 6714279283,
"Acct-Total-Octets": 9095195680
},
{
"UnitID_internal": "USA.VA.22102.CustomerMANAGEDPROPERTIES.City._V3VENUE.USA.DC.20005.Address.City.107.1.1",
"UnitID": "107",
"UnitBuilding": "1",
"UnitFloor": "1",
"UsageReportDateUTC.ISO8601": "2025-06-12T03:59:59.999Z",
"Acct-Input-Octets": 537542254,
"Acct-Output-Octets": 1242068671,
"Acct-Total-Octets": 1779610925
}
],
"errorProcessing": false
}Retrieves a list of property management groups accessible to the network operator. Returns detailed information for each group, including address, contact information, and management URL.
The access token for the network operator admin session.
POST /preview/networkoperatorconsole/venues/listPropertyManagementGroups HTTP/1.1
Host: api.wifikey.io
Content-Type: application/json
Accept: */*
Content-Length: 54
{
"AccessToken": "{{NetworkOperatorAdmin-AccessToken}}"
}List of property management groups returned successfully.
{
"message": "",
"PropertyManagementGroupsCount": 1,
"PropertyManagementGroups": {
"USA.VA.22102.CustomerMANAGEDPROPERTIES.City": {
"dateAddedUTC.ISO8601": "2022-03-21T22:58:35.496Z",
"PropertyManagementGroupName": "Customer Managed Properties",
"AddressLine1": "Fake Address",
"AddressLine2": "5th Floor",
"City": "City",
"State": "VA",
"Country.ISO3166A3": "USA",
"PostalCode": "90210",
"EmailAddress": "[email protected]",
"ManagementURL": "https://wifi.Customer.com",
"PhoneNumber": ""
}
},
"errorProcessing": false
}Adds a new venue to the network operator's account. Requires property management group association and venue details. Returns the created VenueID and related connection information.
The access token for the network operator admin session.
The property management group ID to associate the venue with.
Shared secret for authentication (if required).
Name of the venue.
Address line 1 for the venue.
Address line 2 for the venue (optional).
City where the venue is located.
State where the venue is located.
ISO 3166-1 alpha-3 country code.
Postal code for the venue.
Name of the primary contact.
Given name of the primary contact (optional).
Family name of the primary contact (optional).
Primary contact phone number in E.164 format.
Primary contact email address.
Support phone number in E.164 format (optional).
Support email address (optional).
KeyPool ID to associate with the venue (optional).
Minimum VLAN for residents (optional).
Maximum VLAN for residents (optional).
Minimum VLAN for guests (optional).
Maximum VLAN for guests (optional).
External venue ID (optional).
POST /preview/networkoperatorconsole/venues/addVenue HTTP/1.1
Host: api.wifikey.io
Content-Type: application/json
Accept: */*
Content-Length: 604
{
"AccessToken": "{{NetworkOperatorAdmin-AccessToken}}",
"PropertyManagementGroupID": "{{PropertyManagementGroupID}}",
"SharedSecret": "{{SharedSecret}}",
"VenueName": "GJ Test Venue ABC",
"AddressLine1": "27 Renmar Ave",
"AddressLine2": "",
"City": "SAMPLETOWN3",
"State": "MA",
"Country.ISO3166A3": "USA",
"PostalCode": "12345",
"PrimaryContactName": "Test Contact",
"PrimaryContactPhoneNumber.E164": "+10000000001",
"PrimaryContactEmailAddress": "[email protected]",
"KeyPoolID": "{{KeyPoolID}}",
"MinimumVLAN-Residents": 1050,
"MaximumVLAN-Residents": 4000,
"MinimumVLAN-Guests": 1050,
"MaximumVLAN-Guests": 4000,
"externalVenueID": ""
}Venue added successfully.
{
"message": "",
"VenueID": "USA.MA.67890.CustomerOFFICELOCATIONS.SAMPLETOWN4._V3VENUE.USA.MA.67890.TESTVENUE.SAMPLETOWN4",
"PropertyManagementGroupID": "USA.MA.67890.CustomerOFFICELOCATIONS.SAMPLETOWN4",
"NetworkOperatorConnections": {
"USA.MA.67890.Customer.SAMPLETOWN4": {
"NAS-Identifier": "USA.MA.67890.TESTVENUE.SAMPLETOWN4",
"venueConnectionDateAdded_by_PropertyManagementUTC.ISO8601": "2020-11-01T20:34:19.597Z",
"venueConnectionDateAdded_by_NetworkOperatorUTC.ISO8601": "2020-11-01T20:34:19.597Z",
"currentOperatorStatus": "Operational",
"DefaultVLANForRoamingSubscribers": "2000"
}
},
"Keypools": {
"USA.MA.67890.Customer.SAMPLETOWN4._V3SSID.VAULT.global": {
"dateAdded_by_KeyPoolOwnerUTC.ISO8601": "2020-11-01T20:34:19.597Z",
"dateAdded_by_PropertyManagementUTC.ISO8601": "2020-11-01T20:34:19.597Z",
"ssid": "VAULT"
}
},
"dateAddedUTC.ISO8601": "2020-11-01T20:34:19.597Z"
}Adds a new unit to a specified venue. Requires venue ID and unit details. Returns the created UnitID and VLAN assignment.
The access token for the network operator admin session.
The unique identifier for the venue to which the unit will be added.
VLAN to assign to the unit (optional; may be auto-assigned).
Purpose of the unit (e.g., guest, resident, etc.).
Address line 1 for the unit.
Address line 2 for the unit (optional).
City where the unit is located.
State where the unit is located.
ISO 3166-1 alpha-3 country code.
Postal code for the unit.
POST /preview/networkoperatorconsole/venues/addVenueUnits HTTP/1.1
Host: api.wifikey.io
Content-Type: application/json
Accept: */*
Content-Length: 244
{
"AccessToken": "{{NetworkOperatorAdmin-AccessToken}}",
"VenueID": "{{VenueID}}",
"vlan": "1100",
"purpose": "guest",
"AddressLine1": "2 Annette Rd",
"AddressLine2": "GUEST",
"City": "SAMPLETOWN4",
"State": "MA",
"Country.ISO3166A3": "USA",
"PostalCode": "67890"
}{
"UnitID": "USA.MA.67890.CustomerOFFICELOCATIONS.SAMPLETOWN4._V3VENUE.USA.MA.67890.DDHOMELAB.SAMPLETOWN4.Unit 6.Carriage House.Main",
"VenueID": "USA.MA.67890.CustomerOFFICELOCATIONS.SAMPLETOWN4._V3VENUE.USA.MA.67890.DDHOMELAB.SAMPLETOWN4",
"vlan": "1503",
"errorProcessing": false
}Adds or updates ConnectWise integration credentials for a specific venue. Requires venue ID, ConnectWise API URL, and authorization credentials.
The access token for the network operator admin session.
The unique identifier for the venue.
ConnectWise API URL.
Authorization header value (e.g., Basic or Bearer token).
POST /preview/networkoperatorconsole/venues/addConnectWiseCredentials HTTP/1.1
Host: api.wifikey.io
Content-Type: application/json
Accept: */*
Content-Length: 200
{
"AccessToken": "{{NetworkOperatorAdmin-AccessToken}}",
"VenueID": "{{VenueID}}",
"URL": "https://api-na.myconnectwise.net",
"Authorization": "Basic Qmx1ZXBvcnQrN0NodEF3NHVqUkNqYWJpWTpmbFg0T2VQejlsUDhsZlZp"
}ConnectWise credentials added successfully.
{
"VenueID": "USA.MA.67890.CustomerOFFICELOCATIONS.SAMPLETOWN4._V3VENUE.USA.MA.67890.CustomerHQ.SAMPLETOWN4",
"ConnectWiseURL": "https://api-na.myconnectwise.net",
"errorProcessing": false
}Adds or updates PRTG integration credentials for a specific venue. Requires venue ID, PRTG API URL, username, and password hash.
The access token for the network operator admin session.
The unique identifier for the venue.
PRTG API URL.
PRTG API username.
PRTG API password hash.
POST /preview/networkoperatorconsole/venues/addPRTGCredentials HTTP/1.1
Host: api.wifikey.io
Content-Type: application/json
Accept: */*
Content-Length: 183
{
"AccessToken": "{{NetworkOperatorAdmin-AccessToken}}",
"VenueID": "{{VenueID}}",
"URL": "https://samplemon.samplewireless.com",
"Username": "PRTGApi",
"PasswordHash": "samplepasswordhash123"
}PRTG credentials added successfully.
{
"VenueID": "USA.MA.67890.CustomerOFFICELOCATIONS.SAMPLETOWN4._V3VENUE.USA.MA.67890.CustomerHQ.SAMPLETOWN4",
"PRTGURL": "https://Customermon.Customerwireless.com",
"errorProcessing": false
}Adds a new equipment device to a specified venue. Requires venue ID and equipment details. Returns the created EquipmentID and VenueID.
The access token for the network operator admin session.
The unique identifier for the venue.
Unique identifier for the equipment.
Equipment manufacturer.
Equipment model.
Type of equipment (e.g., Gateway, Switch, etc.).
Wireless zone for the equipment (optional).
Connection protocol (http or https).
IPv4 or IPv6 address of the equipment.
Port number for equipment management interface.
Username for equipment management interface.
Password for equipment management interface.
Set to true if the equipment is a Mikrotik device pre-6.43 (optional).
POST /preview/networkoperatorconsole/venues/addVenueEquipment HTTP/1.1
Host: api.wifikey.io
Content-Type: application/json
Accept: */*
Content-Length: 323
{
"AccessToken": "{{NetworkOperatorAdmin-AccessToken}}",
"VenueID": "{{VenueID}}",
"EquipmentID": "Mikrotik-1",
"Manufacturer": "Mikrotik",
"Model": "CCR",
"EquipmentType": "Gateway",
"WirelessZone": "",
"ConnectionProtocol": "http",
"IPAddress": "203.0.113.42",
"Port": "80",
"Username": "fakeuser",
"Password": "fakepass",
"MikrotikPre643": false
}Venue equipment added successfully.
{
"EquipmentID": "USA.MA.67890.CustomerOFFICELOCATIONS.SAMPLETOWN4._V3VENUE.USA.MA.67890.DDHOMELAB.SAMPLETOWN4._V3EQUIPMENT.Mikrotik-1",
"VenueID": "USA.MA.67890.CustomerOFFICELOCATIONS.SAMPLETOWN4._V3VENUE.USA.MA.67890.DDHOMELAB.SAMPLETOWN4",
"errorProcessing": false
}Updates the configuration of a specific venue unit. Allows updating address, VLAN, shopping cart settings, and other unit-level options.
The access token for the network operator admin session.
The unique internal identifier for the venue unit.
Address line 1 for the unit.
Address line 2 for the unit (optional).
City where the unit is located.
State where the unit is located.
ISO 3166-1 alpha-3 country code.
Postal code for the unit.
SMS code for the unit (optional).
Shopping cart price adjustment for the unit (optional).
Allow overlapping subscription for wired unit (optional).
Enable shopping cart for the unit (optional).
VLAN to assign to the unit (optional).
POST /preview/networkoperatorconsole/venues/configureVenueUnit HTTP/1.1
Host: api.wifikey.io
Content-Type: application/json
Accept: */*
Content-Length: 443
{
"AccessToken": "{{NetworkOperatorAdmin-AccessToken}}",
"AddressLine1": "27 Renmar Ave",
"AddressLine2": "Suite 2",
"City": "SAMPLETOWN3",
"State": "MA",
"Country.ISO3166A3": "USA",
"PostalCode": "12345",
"SMSCode": "",
"ShoppingCartPriceAdjustment": -500,
"UnitID_internal": "USA.SAMPLE.12345.SAMPLEPROPERTY.SAMPLECITY._V3VENUE.USA.MA.12345.SAMPLERESIDENCE.SAMPLETOWN3.102.2.1",
"allowOverlappingSubscriptionWiredUnit": true,
"enableShoppingCart": true,
"vlan": 2011
}Venue unit configuration updated successfully.
{
"message": "Unit updated. Policies updated, ",
"errorProcessing": false
}Updates the configuration for a specific equipment record at a venue. Allows updating manufacturer, model, type, connection protocol, credentials, and other equipment-specific options. Returns the EquipmentID and VenueID if successful.
The access token for the network operator admin session.
The unique identifier for the venue.
The unique identifier for the equipment.
The equipment manufacturer.
The equipment model.
The type of equipment (e.g., Gateway, Switch).
The wireless zone (optional).
The connection protocol (e.g., http, https).
The IP address of the equipment.
The port number for connection.
The username for equipment access.
The password for equipment access.
Optional. Set to true if the equipment is a Mikrotik device with firmware pre-6.43.
POST /preview/networkoperatorconsole/venues/updateVenueEquipment HTTP/1.1
Host: api.wifikey.io
Content-Type: application/json
Accept: */*
Content-Length: 323
{
"AccessToken": "{{NetworkOperatorAdmin-AccessToken}}",
"VenueID": "{{VenueID}}",
"EquipmentID": "Mikrotik-1",
"Manufacturer": "Mikrotik",
"Model": "CCR",
"EquipmentType": "Gateway",
"WirelessZone": "",
"ConnectionProtocol": "http",
"IPAddress": "203.0.113.42",
"Port": "80",
"Username": "fakeuser",
"Password": "fakepass",
"MikrotikPre643": false
}{
"message": "",
"EquipmentID": "USA.SAMPLE.12345.SAMPLEPROPERTY.SAMPLECITY._V3VENUE.USA.MA.12345.SAMPLERESIDENCE.SAMPLETOWN3._V3EQUIPMENT.Mikrotik-1",
"VenueID": "USA.SAMPLE.12345.SAMPLEPROPERTY.SAMPLECITY._V3VENUE.USA.MA.12345.SAMPLERESIDENCE.SAMPLETOWN3",
"errorProcessing": false
}Updates the configuration for a specific venue. Allows updating address, contact, VLAN ranges, service plan, shopping cart, and other venue-specific options. Returns a message indicating what was updated.
The access token for the network operator admin session.
The unique identifier for the venue.
Optional. External venue ID.
Optional. Venue type (WIRED+WIFI, WIRED, etc.).
Optional. Name of the venue.
Optional. Street address line 1.
Optional. Street address line 2.
Optional. City.
Optional. State or region.
Optional. Country code (ISO 3166-1 alpha-3).
Optional. Postal code.
Optional. Welcome email countdown in hours.
Optional. Send subscription end email.
Optional. Reporting subscription end lookahead in hours.
Optional. Reporting subscription end frequency in hours.
Optional. Given name of the primary contact.
Optional. Family name of the primary contact.
Optional. Primary contact email address.
Optional. Primary contact phone number in E.164 format.
Optional. Default subscription duration (hours) for global wireless plus local wired access.
Optional. Default subscription duration (hours) for local wireless access.
Optional. Default service plan ID for global wireless plus local wired access.
Optional. Default service plan ID for local wireless access.
Optional. Minimum auto-generated VLAN for global wireless plus local wired access.
Optional. Maximum auto-generated VLAN for global wireless plus local wired access.
Optional. Minimum auto-generated VLAN for local wireless access.
Optional. Maximum auto-generated VLAN for local wireless access.
Optional. Minimum auto-generated VLAN for global wireless roaming.
Optional. Maximum auto-generated VLAN for global wireless roaming.
Optional. Enable RealPage sync.
Optional. RealPage site ID.
Optional. RealPage PMC ID.
Optional. Enable or disable the shopping cart for this venue.
Optional. Shopping cart currency.
Optional. Price adjustment for the shopping cart (can be negative or positive).
Optional. Trial cycle adjustment.
POST /preview/networkoperatorconsole/venues/configureVenue HTTP/1.1
Host: api.wifikey.io
Content-Type: application/json
Accept: */*
Content-Length: 1504
{
"AccessToken": "{{NetworkOperatorAdmin-AccessToken}}",
"VenueID": "{{VenueID}}",
"externalVenueID": "DNDeerfield",
"VenueType": "WIRED+WIFI",
"VenueName": "Venue Name",
"AddressLine1": "27 Renmar Ave",
"AddressLine2": "Line 2",
"City": "SAMPLETOWN3",
"State": "MA",
"Country.ISO3166A3": "USA",
"PostalCode": "12345",
"WelcomeEmail_countdown_hours": 168,
"SendSubscriptionEndEmail": true,
"ReportingSubscriptionEnd_lookahead_hours": 336,
"ReportingSubscriptionEnd_frequency_hours": 168,
"PrimaryContactGivenName": "Test",
"PrimaryContactFamilyName": "Contact",
"PrimaryContactEmailAddress": "[email protected]",
"PrimaryContactPhoneNumber.E164": "+10000000002",
"DefaultSubscriptionDurationHours_GlobalWirelessPlusLocalWiredAccess": 0,
"DefaultSubscriptionDurationHours_LocalWirelessAccess": 24,
"DefaultServicePlanID_GlobalWirelessPlusLocalWiredAccess": "USA.CO.80112.Customer.ENGLEWOOD._V3SERVICEPLAN_.200MBPSRETAIL",
"DefaultServicePlanID_LocalWirelessAccess": "USA.CO.80112.Customer.ENGLEWOOD._V3SERVICEPLAN_.100MBPS",
"MinimumAutoGeneratedVLAN_GlobalWirelessPlusLocalWiredAccess": 1,
"MaximumAutoGeneratedVLAN_GlobalWirelessPlusLocalWiredAccess": 4000,
"MinimumAutoGeneratedVLAN_LocalWirelessAccess": 1,
"MaximumAutoGeneratedVLAN_LocalWirelessPlusLocalWiredAccess": 4000,
"MinimumAutoGeneratedVLAN_GlobalWirelessRoaming": 1,
"MaximumAutoGeneratedVLAN_GlobalWirelessRoaming": 4000,
"enableRealPageSync": false,
"RealPageSiteId": 123456,
"RealPagePMCId": "",
"enableShoppingCart": true,
"Currency": "USD",
"ShoppingCartPriceAdjustment": -500,
"TrialCycleAdjustment": -1
}{
"message": "Updating TrialCycleAdjustment to -1. ",
"errorProcessing": false
}Enables a specific service plan for a venue. Requires the venue ID and the service plan ID. Returns the ServicePlanID and VenueID if successful.
The access token for the network operator admin session.
The unique identifier for the venue.
The unique identifier for the service plan to enable.
POST /preview/networkoperatorconsole/venues/enableServicePlan HTTP/1.1
Host: api.wifikey.io
Content-Type: application/json
Accept: */*
Content-Length: 160
{
"AccessToken": "{{NetworkOperatorAdmin-AccessToken}}",
"VenueID": "{{VenueID}}",
"ServicePlanID": "USA.CO.80112.Customer.ENGLEWOOD._V3SERVICEPLAN_.50GBPS-BALANCED"
}{
"message": "",
"ServicePlanID": "USA.CO.80112.Customer.ENGLEWOOD._V3SERVICEPLAN_.50GBPS-BALANCED",
"VenueID": "USA.CO.80112.CustomerFIBERDEFAULTPROPERTYGROUP.ENGLEWOOD._V3VENUE.USA.MA.12345.GJTESTVE.SAMPLETOWN3"
}Disables a specific service plan for a venue. Requires the venue ID and the service plan ID. Returns the ServicePlanID if successful.
The access token for the network operator admin session.
The unique identifier for the venue.
The unique identifier for the service plan to disable.
POST /preview/networkoperatorconsole/venues/disableServicePlan HTTP/1.1
Host: api.wifikey.io
Content-Type: application/json
Accept: */*
Content-Length: 160
{
"AccessToken": "{{NetworkOperatorAdmin-AccessToken}}",
"VenueID": "{{VenueID}}",
"ServicePlanID": "USA.CO.80112.Customer.ENGLEWOOD._V3SERVICEPLAN_.50GBPS-BALANCED"
}{
"message": "Plan disabled. ",
"ServicePlanID": "USA.CO.80112.Customer.ENGLEWOOD._V3SERVICEPLAN_.50GBPS-BALANCED"
}Grants staff access to a venue for a specified user. Requires the venue ID, user email, role, and contact details. Returns the enabled status, user details, administrative access, and other relevant information.
The access token for the network operator admin session.
The unique identifier for the venue.
The email address of the staff member to enable.
The role to assign (e.g., "VenueAdministrator" or "LeasingAgent").
The given name of the staff member.
The family name of the staff member.
The staff member's phone number in E.164 format.
The locale for the staff member (e.g., en-us).
Whether the staff member prefers SMS contact.
Whether the staff member prefers voice contact.
POST /preview/networkoperatorconsole/venues/enableStaffAccess HTTP/1.1
Host: api.wifikey.io
Content-Type: application/json
Accept: */*
Content-Length: 283
{
"AccessToken": "{{NetworkOperatorAdmin-AccessToken}}",
"VenueID": "{{VenueID}}",
"EmailAddress": "[email protected]",
"Role": "VenueAdministrator",
"GivenName": "John",
"FamilyName": "Doe",
"PhoneNumber.E164": "+12345678903",
"locale": "en-us",
"contactpref_sms": false,
"contactpref_voice": false
}{
"Enabled": true,
"Status": "AUP not accepted",
"EmailAddress": "[email protected]",
"SubscriberToken": "PotrRoce",
"PhoneNumber.E164": "+12345678904",
"locale": "en-us",
"GivenName": "Test",
"FamilyName": "Contact",
"externalReferenceID": "",
"contactpref_sms": false,
"contactpref_email": false,
"dateAddedUTC.ISO8601": "2022-02-09T18:23:19.473Z",
"AdministrativeAccess": {
"NetworkSoftwareProviderAdministrator": [],
"PropertyManagementAdministrator": [],
"NetworkOperatorAdministrator": [],
"VenueAdministrator": [
"USA.CO.80112.CustomerFIBERDEFAULTPROPERTYGROUP.ENGLEWOOD._V3VENUE.USA.CA.91320.9MADRIDU.NEWBURYPA"
],
"LeasingAgent": []
},
"errorProcessing": false
}Was this helpful?