Get Child Accounts
GET
/api/v1/accounts/{macnum}/childrenAccountsReturns the list of child accounts by provided parent macnum.
Auth Scope
urn:grt:accountsContent-Type
application/jsonRate Limit
60 req/min
Headers
| Header | Value |
|---|---|
Authorization | Bearer access-token |
Path Parameters
| Parameter | Type | Required | Description |
|---|---|---|---|
macnum | string | Yes | Parent account number (macnum) |
Response
Success Response (200 OK)
Response Fields
| Field | Type | Description |
|---|---|---|
records | list | A list of objects containing account and address details |
total_count | integer | The total number of records returned in the list |
Record Object Fields
| Field | Type | Description |
|---|---|---|
child_account_number | string | The macnum of the specific child account |
parent_account_number | string | The macnum of the parent account associated with the child record |
street | string | The street address of the location |
city | string | The city name |
state | string | The state or region abbreviation |
zip | string | The postal or zip code of the location |
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:accounts). Contact your administrator to request the appropriate permissions. |
404 | Not Found | The parent account with the provided macnum was not found. Verify the macnum is correct. |
Last updated on