Search Accounts

GET/api/v1/companies/addressesTechExpress

Returns list of accounts by provided search parameter.

Auth Scope

urn:grt:techexpress

Content-Type

application/json

Rate Limit

60 req/min

Headers

Header	Value
`Authorization`	`Bearer access-token`

Parameter	Type	Required	Description
`search`	string	Yes	Parameter for accounts lookup
`granted_tenant_macnum`	string	No	The company macnum on whose behalf the action is performed
`page_size`	integer	No	The number of results to return per page

Response contains list of Account objects found by searching criteria. Each object has the following fields:

Field	Type	Description
`address_line_1`	string	The primary street address of the account or location
`address_line_2`	string	The second line of the street address, if applicable
`city`	string	The city where the account is situated
`company_name`	string	The name of the main company associated with this account
`id`	integer	A unique numerical identifier for this specific account record within the system
`local_contact_name`	string	The name of a local contact person for this account/location
`local_contact_phone`	string	The phone number of a local contact person
`location_contact_email`	string	The email address of a local contact person for this account/location
`macnum`	string	A unique identifier, likely a "MAC number" or a similar internal alphanumeric code, for this specific account or location
`name`	string	A descriptive name for the account or location, often combining its macnum and a site-specific identifier (e.g., "03526768 - 040010")
`parent_macnum`	string	The unique identifier (e.g., MAC number) of the parent company or overarching entity to which this account/location belongs
`parent_name`	string	The name of the parent company or entity to which this account/location belongs
`state`	string	The two-letter state code (e.g., "KY") for the account or location's address
`zip`	string	The postal code (zip code) for the account or location's address

HTTP Status	Error Description	Resolution
`400`	Bad Request	The search parameter is required. Ensure it is provided in the query string.
`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:techexpress`). Contact your administrator to request the appropriate permissions.