Sites with Configurations List

GET/api/v1/inventory/sites/externalInventory

Returns the list of available sites with associated network configurations.

Auth Scope

urn:grt:inventory

Content-Type

application/json

Rate Limit

60 req/min

Headers

Header	Value
`Authorization`	`Bearer access-token`

Query Parameters

Parameter	Type	Required	Description
`granted_tenant_macnum`	string	No	The company macnum on whose behalf the action is performed
`macnum`	string	No	Filter results to a specific site by its macnum
`page`	integer	No	Page number for pagination (starting at 1). Default: `1`
`page_size`	integer	No	Number of sites per page. Must be between 1 and 10000. Default: `10000`

Response

Success Response (200 OK)

Response Fields

Field	Type	Description
`data`	array	A list containing objects, where each object represents a site with its associated network configurations
`metadata`	object	An object containing pagination information for the dataset

Site Object Fields

Field	Type	Description
`address`	string	The street address of the site location
`city`	string	The city where the site is located
`state`	string	The two-letter state abbreviation for the site's location
`zip`	string	The postal ZIP code for the site's address
`macnum`	string	The unique identifier or MAC number for the site
`site_name`	string	The descriptive name of the site, typically including the MAC number and business name
`site_type`	string	The classification or type of the site (e.g., "Child - Par Pays")
`configurations`	array	A list of network configuration objects associated with this site. Each configuration object contains the fields listed below

Configuration Object Fields

Field	Type	Description
`config_name`	string	The unique identifier or name for this configuration
`config_status`	string	The current status of the configuration
`config_type`	string	The type of network configuration
`carrier`	string	The telecommunications carrier providing the service
`product_offering`	string	The product or service type being offered
`ticket_type`	string	The category of the service ticket
`ticket_subtype`	string	The specific subcategory of the ticket
`ip_address`	string	The IP address assigned to the configuration
`gateway`	string	The network gateway address
`subnet_mask`	string	The subnet mask for the network configuration
`speed`	string	The connection speed or bandwidth of the service
`circuit_id`	string	The identifier for the circuit, if applicable
`access_type`	string	The type of network access
`completion_date`	string	The date when the configuration was completed
`contract_start_date`	string	The start date of the service contract
`contract_end_date`	string	The end date of the service contract
`contract_term`	string	The duration or term of the contract
`end_date`	string	The termination or end date for the service
`dns_1`	string	The primary DNS server address
`dns_2`	string	The secondary DNS server address
`ip_quantity`	string	The number of IP addresses allocated
`ip_type`	string	The type of IP addressing
`mac_address`	string	The MAC address of the network device
`modem_serial_number`	string	The serial number of the modem or network equipment
`product_code`	string	The internal product code for the service
`rate`	string	The pricing or rate information for the service
`vendor`	string	The vendor or provider of the network equipment or service

Metadata Object Fields

Field	Type	Description
`page`	integer	The current page number being displayed
`page_size`	integer	The maximum number of records returned per page
`total_items`	integer	The total number of site records available across all pages
`total_pages`	integer	The total number of pages in the dataset

Code Examples

Errors

HTTP Status	Error Description	Resolution
`401`	Authentication Failed	Verify your access token is valid and included in the Authorization header with the "Bearer " prefix.
`403`	Permission Denied	Your access token does not have the required scope (`urn:grt:inventory`). Contact your administrator to request the appropriate permissions.