Services List

GET/api/v1/inventory/servicesInventory

Returns the list of available services.

Auth Scope

urn:grt:inventory

Content-Type

application/json

Rate Limit

60 req/min

Headers

Header	Value
`Authorization`	`Bearer access-token`

Parameter	Type	Required	Description
`service_type`	string	No	Parameter to filter by service type
`vendor`	string	No	Parameter to filter by vendor name
`status`	string	No	Parameter to filter by status
`completion_date`	string	No	Parameter to filter by completion date
`end_date`	string	No	Parameter to filter by end date
`page`	integer	No	Page number for pagination (starting at 1). Default: `1`
`page_size`	integer	No	Number of services per page. Must be between 1 and 100. Default: `20`
`search`	string	No	Search parameter
`sort_field`	string	No	Field to sort the results by
`sort_order`	string	No	Sort direction: `"ASC"` or `"DESC"`. Default: `"DESC"`
`granted_tenant_macnum`	string	No	The company macnum on whose behalf the action is performed

To get filtering options for service_type, vendor, status, completion_date, end_date, sort_field use the static endpoint.

Field	Type	Description
`results`	array	A list containing objects, where each object represents a specific service or equipment record
`info`	object	An object containing pagination details for the entire dataset

Field	Type	Description
`parent_name`	string	The name of the parent entity
`parent_number`	string	The identifier number for the parent entity
`account_number`	string	The identifier number for the specific account
`account_name`	string	The descriptive name of the account
`address`	string	The street address for the account site
`state`	string	The state or province of the account's address
`city`	string	The city of the account's address
`zip`	string	The postal or ZIP code for the account's address
`service_type`	string	The category of the service provided (e.g., "Equipment")
`vendor`	string, optional	The name of the vendor associated with the service, if applicable
`service_id`	string	The unique identifier for this specific service record
`status`	string	The current status of the service (e.g., "Active")
`completion_date`	string	The date when the service was completed or installed
`end_date`	string, optional	The end date for the service, if applicable
`btn`	string	The Billing Telephone Number associated with the service
`serial_number`	string, optional	The serial number of the equipment, if applicable
`mac`	string, optional	The MAC address of the equipment, if applicable
`model_number`	string	The model number or identifier for the product
`ip`	string, optional	The IP address of the equipment, if applicable
`tag_number`	string	An asset tag or tracking number for the equipment
`product_offering`	string, optional	The specific product offering name, if applicable
`inventory_id`	integer	The unique identifier for the item in the inventory system

Field	Type	Description
`total_pages`	integer	The total number of pages available
`total_records`	integer	The total number of records across all pages
`page_size`	integer	The number of records displayed per page
`page`	integer	The current page number
`next_page`	integer	The number of the next page in the sequence

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.