Verato

Verato HouseholdQuery API

The HouseholdQuery API from Verato — 1 operation(s) for householdquery.

Documentation GitHub OpenAPI

Operations 1

POST /householdQuery Query for Household (householdQuery) #

Specifications

⚙

OpenAPI

https://raw.githubusercontent.com/api-evangelist/verato/refs/heads/main/openapi/verato-householdquery-api-openapi.yml

Work with this as data

Every API here is available over the APIs.io API and to AI agents over MCP.

MCP server

One button, every client — Claude, Cursor, VS Code and the rest.

https://apis.io/mcp

Tools for apis

7 MCP tools reach this

find_apisBrowse and filter every API in the catalog.
get_api_artifactsOne API's artifacts, grouped by type.
get_openapiThe primary OpenAPI for this API.
find_similar_apisAPIs that look like this one.
apis_io_searchSTART HERE — APIs, providers and tags for one query, each with its total.
resolveTurn a domain, URL or GitHub org into the provider it belongs to.
find_cohortsEvery scored population of providers in the catalog.

All 92 tools →

Call it yourself

curl for this page

This API

curl "https://apis.io/api/v1/apis/verato-householdquery-api"

All apis

curl "https://apis.io/api/v1/apis?limit=25"

Discovery needs no key. Ratings and market analysis are Pro.

Get an API key

Free tier, no form to fill in. Signing in shares your email address with us — we store it to create your key and to recognise you if you sign in with another provider. See our Privacy Policy and Terms.

GitHub Google LinkedIn

A second provider on the same verified email joins the account you already have.

OpenAPI Specification

openapi: 3.2.0
info:
  title: Verato Person Household Query API
  version: 2026.1.2
servers:
- url: https://yourveratodomain.com/link-ws/svc
  description: Production Link API
- url: https://yourveratodomain.com/link-ws/svc
  description: Sandbox Link API
security:
- basicAuth: []
tags:
- name: HouseholdQuery
paths:
  /householdQuery:
    post:
      summary: Query for Household (householdQuery)
      description: Used to retrieve the collection of Link IDs that have been grouped into a household.
      operationId: post_householdQuery
      responses:
        '200':
          description: OK
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ServiceResponse_householdQuery'
      requestBody:
        required: true
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/ServiceRequest_householdQuery'
      tags:
      - HouseholdQuery
components:
  schemas:
    HouseholdQueryWsRequest:
      type: object
      properties:
        householdId:
          type: string
          description: The householdId to use in the query
        linkId:
          type: string
          description: The link ID to use in the query
        source:
          $ref: '#/components/schemas/Source'
          description: The SourceNative to use in the query
    HouseholdQueryWsResponse:
      type: object
      properties:
        householdId:
          type: string
          description: The householdId.
        lastUpdateDate:
          type: string
          format: date-time
        linkIdsInHousehold:
          type: array
          items:
            type: string
          uniqueItems: true
          description: Current linkIds in the household.
        createDate:
          type: string
          format: date-time
      required:
      - householdId
      - linkIdsInHousehold
    ServiceRequest_householdQuery:
      type: object
      properties:
        content:
          $ref: '#/components/schemas/HouseholdQueryWsRequest'
        trackingId:
          type: string
    ServiceResponse_householdQuery:
      type: object
      properties:
        auditId:
          type: string
        success:
          type: boolean
        warnings:
          type: array
          items:
            type: string
        retryableError:
          type: boolean
        message:
          type: string
        content:
          $ref: '#/components/schemas/HouseholdQueryWsResponse'
        errors:
          type: array
          items:
            type: string
        trackingId:
          type: string
    Source:
      type: object
      properties:
        date:
          type: string
          description: The date of the source data in ISO format (yyyy-mm-dd).
        name:
          type: string
          description: The name of the data source.  Must be unique across Verato.
        id:
          type: string
          description: The ID of an identity within the given data source.
      description: Represents the information tracking an identity to a source that contains the identity
  securitySchemes:
    basicAuth:
      type: http
      scheme: basic