Get Contact Household
GET /v2/partner/contacts/{id}/household
Required scopes
partner:contacts:read
Tokens missing any required scope return 401 scope_missing.
See Auth & Scopes for issuance.
Operation
| Operation ID | getContactHousehold |
| Tags | Audience |
Parameters
| Name | In | Type | Description |
|---|---|---|---|
| id * | path | id |
Responses
200
OK
object
| Field | Type | Description |
|---|---|---|
| data * | object[] | |
| page * | page |
Example request
GET https://api.digitalonboarding.com/v2/partner/contacts/{id}/household
Authorization: Bearer <partner-token>