List households
curl --request GET \
--url https://api.vegaminds.com/v1/households \
--header 'Authorization: Bearer <token>'import requests
url = "https://api.vegaminds.com/v1/households"
headers = {"Authorization": "Bearer <token>"}
response = requests.get(url, headers=headers)
print(response.text)const options = {method: 'GET', headers: {Authorization: 'Bearer <token>'}};
fetch('https://api.vegaminds.com/v1/households', options)
.then(res => res.json())
.then(res => console.log(res))
.catch(err => console.error(err));{
"data": [
{
"id": "46852331-f25c-4fcc-9d16-2162c96be9ad",
"is_external": false,
"name": "Ellis family",
"household_type": "client",
"members": [
{
"contact_id": "1f128fef-f499-4c88-a53e-75f235ccb65a",
"first_name": "Jordan",
"last_name": "Ellis",
"relationship": "head"
},
{
"contact_id": "36bb28a0-ace0-43cc-ae70-077c02fb58e5",
"first_name": "Sam",
"last_name": "Ellis",
"relationship": "spouse"
}
]
}
],
"page": 1,
"limit": 50,
"has_more": false
}{
"error": {
"code": "invalid_request",
"message": "The request body is invalid.",
"fields": {
"email_addresses[0].address": "Must be an email address."
}
},
"request_id": "3f6c1e9a-2b7d-4c58-9e41-8a0d5b7f2c16"
}{
"error": {
"code": "invalid_token",
"message": "The access token is invalid, expired or revoked."
},
"request_id": "3f6c1e9a-2b7d-4c58-9e41-8a0d5b7f2c16"
}{
"error": {
"code": "insufficient_scope",
"message": "This request needs the contacts:write scope, which the user did not grant. Connect the user again, asking for it."
},
"request_id": "3f6c1e9a-2b7d-4c58-9e41-8a0d5b7f2c16"
}{
"error": {
"code": "rate_limited",
"message": "Too many requests. Wait the number of seconds in the Retry-After header, then try again."
}
}{
"error": {
"code": "internal_error",
"message": "Something went wrong on our side. Try again later, and contact Vega support with the request id if it keeps happening."
},
"request_id": "3f6c1e9a-2b7d-4c58-9e41-8a0d5b7f2c16"
}Households
List households
The households the user can see, by name. With query, the closest matches come first.
GET
/
households
List households
curl --request GET \
--url https://api.vegaminds.com/v1/households \
--header 'Authorization: Bearer <token>'import requests
url = "https://api.vegaminds.com/v1/households"
headers = {"Authorization": "Bearer <token>"}
response = requests.get(url, headers=headers)
print(response.text)const options = {method: 'GET', headers: {Authorization: 'Bearer <token>'}};
fetch('https://api.vegaminds.com/v1/households', options)
.then(res => res.json())
.then(res => console.log(res))
.catch(err => console.error(err));{
"data": [
{
"id": "46852331-f25c-4fcc-9d16-2162c96be9ad",
"is_external": false,
"name": "Ellis family",
"household_type": "client",
"members": [
{
"contact_id": "1f128fef-f499-4c88-a53e-75f235ccb65a",
"first_name": "Jordan",
"last_name": "Ellis",
"relationship": "head"
},
{
"contact_id": "36bb28a0-ace0-43cc-ae70-077c02fb58e5",
"first_name": "Sam",
"last_name": "Ellis",
"relationship": "spouse"
}
]
}
],
"page": 1,
"limit": 50,
"has_more": false
}{
"error": {
"code": "invalid_request",
"message": "The request body is invalid.",
"fields": {
"email_addresses[0].address": "Must be an email address."
}
},
"request_id": "3f6c1e9a-2b7d-4c58-9e41-8a0d5b7f2c16"
}{
"error": {
"code": "invalid_token",
"message": "The access token is invalid, expired or revoked."
},
"request_id": "3f6c1e9a-2b7d-4c58-9e41-8a0d5b7f2c16"
}{
"error": {
"code": "insufficient_scope",
"message": "This request needs the contacts:write scope, which the user did not grant. Connect the user again, asking for it."
},
"request_id": "3f6c1e9a-2b7d-4c58-9e41-8a0d5b7f2c16"
}{
"error": {
"code": "rate_limited",
"message": "Too many requests. Wait the number of seconds in the Retry-After header, then try again."
}
}{
"error": {
"code": "internal_error",
"message": "Something went wrong on our side. Try again later, and contact Vega support with the request id if it keeps happening."
},
"request_id": "3f6c1e9a-2b7d-4c58-9e41-8a0d5b7f2c16"
}Authorizations
Query Parameters
Only the records whose updated_on is at or after this timestamp, which needs a time zone offset. To keep a copy in sync, pass the latest updated_on you have stored, as returned (it ends in Z); records updated in that same second come back again. Write an offset's + as %2B, since a + in a URL reads as a space.

