Skip to main content
GET
cURL

Authorizations

Authorization
string
header
required

Vings OAuth access token or personal access token (vng_pat_…). Use Authorization: Bearer ….

Response

Read-only household context for this credential. Membership changes stay in the Vings app.

scope
enum<string>
required

personal is this credential owner's own rows. household includes every member when the credential owner belongs to a two-member household. Joining is the consent; a second credential approval is not required.

Available options:
personal,
household
household_id
string<uuid> | null
required
membership_version
integer
required
reporting_currency
string | null
required
member_count
integer
required
integration_approved
boolean
required
Available options:
not_required,
required,
approved
members
object[]
required