Search Sites
GET
/api/v1/noc/companies/sitesNOCExpressReturns the list of available accounts found by searching criteria.
Auth Scope
urn:grt:nocexpressContent-Type
application/jsonRate Limit
60 req/min
Headers
| Header | Value |
|---|---|
Authorization | Bearer access-token |
Query Parameters
| Parameter | Type | Required | Description |
|---|---|---|---|
search | string | No | Parameter for accounts lookup by location name |
account | string | No | Parameter for accounts lookup by account |
store | string | No | Parameter for accounts lookup by store |
page_size | integer | No | Desired page size |
granted_tenant_macnum | string | No | The company macnum on whose behalf the action is performed |
Response
Success Response (200 OK)
Response Fields
| Field | Type | Description |
|---|---|---|
name | string | The primary name associated with the company site |
address_line_1 | string | The first line of the street address for the company site |
address_line_2 | string, optional | The second line of the street address for the company site, if applicable |
city | string | The city where the company site is located |
state | string, optional | The state or province where the company site is located |
zip | string | The postal code or ZIP code for the company site |
id | integer | A unique identifier for the company site |
parent_macnum | string, optional | The MAC number of the parent company or entity |
parent_name | string, optional | The name of the parent company or entity |
site_name | string, optional | The specific name given to this particular site |
account_name | string, optional | The name of the account associated with this company site |
parent_account | string | The identifier of the parent company account |
macnum | string, optional | The MAC number for this specific company site |
is_chronic | bool | States if site has a number of tickets created |
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:nocexpress). Contact your administrator to request the appropriate permissions. |
Last updated on