Skip to main content
GET
/
v1
/
households
/
{household}
/
contacts
/
{contact}
Get a contact associated with a household
curl --request GET \
  --url https://api.givebutter.com/v1/households/{household}/contacts/{contact} \
  --header 'Authorization: Bearer <token>'
{
  "id": "<string>",
  "external_id": "<string>",
  "contact_since": "<string>",
  "type": "<string>",
  "prefix": "<string>",
  "first_name": "<string>",
  "preferred_name": "<string>",
  "middle_name": "<string>",
  "last_name": "<string>",
  "suffix": "<string>",
  "gender": "<string>",
  "pronouns": "<string>",
  "dob": "<string>",
  "company": "<string>",
  "employer": "<string>",
  "company_name": "<string>",
  "title": "<string>",
  "website_url": "<string>",
  "twitter_url": "<string>",
  "linkedin_url": "<string>",
  "facebook_url": "<string>",
  "tiktok_url": "<string>",
  "emails": [
    {
      "type": "<string>",
      "value": "<string>"
    }
  ],
  "phones": [
    {
      "type": "<string>",
      "value": "<string>"
    }
  ],
  "primary_email": "<string>",
  "primary_phone": "<string>",
  "note": "<string>",
  "addresses": [
    {
      "address_1": "<string>",
      "address_2": "<string>",
      "city": "<string>",
      "state": "<string>",
      "zipcode": "<string>",
      "country": "<string>",
      "type": "<string>",
      "is_primary": true,
      "created_at": "2023-11-07T05:31:56Z",
      "updated_at": "2023-11-07T05:31:56Z"
    }
  ],
  "primary_address": {
    "address_1": "<string>",
    "address_2": "<string>",
    "city": "<string>",
    "state": "<string>",
    "zipcode": "<string>",
    "country": "<string>",
    "type": "<string>",
    "is_primary": true,
    "created_at": "2023-11-07T05:31:56Z",
    "updated_at": "2023-11-07T05:31:56Z"
  },
  "last_donation_amount": "<string>",
  "stats": {
    "total_contributions": "<string>",
    "recurring_contributions": "<string>"
  },
  "tags": "<string>",
  "custom_fields": [
    "<unknown>"
  ],
  "external_ids": [
    {
      "id": 123,
      "label": "<string>",
      "external_id": "<string>",
      "created_at": "<string>",
      "updated_at": "<string>"
    }
  ],
  "is_email_subscribed": "<string>",
  "is_phone_subscribed": "<string>",
  "is_address_subscribed": "<string>",
  "email_opt_in": "<string>",
  "sms_opt_in": "<string>",
  "address_unsubscribed_at": "<string>",
  "archived_at": "<string>",
  "created_at": "<string>",
  "updated_at": "<string>",
  "salutation_name": "<string>",
  "point_of_contact": {
    "id": "<string>",
    "type": "<string>",
    "prefix": "<string>",
    "first_name": "<string>",
    "middle_name": "<string>",
    "last_name": "<string>",
    "suffix": "<string>",
    "gender": "<string>",
    "pronouns": "<string>",
    "dob": "<string>",
    "employer": "<string>",
    "title": "<string>",
    "twitter_url": "<string>",
    "linkedin_url": "<string>",
    "facebook_url": "<string>",
    "tiktok_url": "<string>",
    "website_url": "<string>",
    "emails": {},
    "phones": {},
    "primary_email": "<string>",
    "primary_phone": "<string>",
    "is_email_subscribed": "<string>",
    "is_phone_subscribed": "<string>",
    "is_address_subscribed": "<string>",
    "address_unsubscribed_at": "<string>",
    "archived_at": "<string>",
    "created_at": "<string>",
    "updated_at": "<string>",
    "first_time_supporter_at": "<string>"
  },
  "associated_companies": [
    {
      "id": "<string>",
      "type": "<string>",
      "company_name": "<string>",
      "name_display": "<string>",
      "title": "<string>",
      "twitter_url": "<string>",
      "linkedin_url": "<string>",
      "facebook_url": "<string>",
      "tiktok_url": "<string>",
      "website_url": "<string>",
      "image_url": "<string>",
      "emails": {},
      "phones": {},
      "primary_email": "<string>",
      "primary_phone": "<string>",
      "is_email_subscribed": "<string>",
      "is_phone_subscribed": "<string>",
      "is_address_subscribed": "<string>",
      "address_unsubscribed_at": "<string>",
      "note": "<string>",
      "addresses": [
        {
          "id": 123,
          "account_id": 123,
          "name": "<string>",
          "address_1": "<string>",
          "address_2": "<string>",
          "city": "<string>",
          "state": "<string>",
          "zipcode": "<string>",
          "country": "<string>",
          "type": "<string>",
          "is_primary": true,
          "created_at": "2023-11-07T05:31:56Z",
          "updated_at": "2023-11-07T05:31:56Z"
        }
      ],
      "primary_address": {
        "id": 123,
        "account_id": 123,
        "name": "<string>",
        "address_1": "<string>",
        "address_2": "<string>",
        "city": "<string>",
        "state": "<string>",
        "zipcode": "<string>",
        "country": "<string>",
        "type": "<string>",
        "is_primary": true,
        "created_at": "2023-11-07T05:31:56Z",
        "updated_at": "2023-11-07T05:31:56Z"
      },
      "archived_at": "<string>",
      "created_at": "<string>",
      "updated_at": "<string>",
      "first_time_supporter_at": "<string>"
    }
  ]
}

Authorizations

​
Authorization
string
header
required

Bearer authentication header of the form Bearer <token>, where <token> is your auth token.

Path Parameters

​
household
integer
required

The household ID

​
contact
integer
required

The contact ID

Response

ContactResource

​
id
string
required
​
external_id
string
required
​
contact_since
string
required
​
type
string
required
​
prefix
string
required
​
first_name
string
required
​
preferred_name
string
required
​
middle_name
string
required
​
last_name
string
required
​
suffix
string
required
​
gender
string
required
​
pronouns
string
required
​
dob
string
required
​
company
string
required
​
employer
string
required
​
company_name
string
required
​
title
string
required
​
website_url
string
required
​
twitter_url
string
required
​
linkedin_url
string
required
​
facebook_url
string
required
​
tiktok_url
string
required
​
emails
EmailResource · object[]
required
​
phones
PhoneResource · object[]
required
​
primary_email
string
required
​
primary_phone
string
required
​
note
string
required
​
addresses
App.Http.Resources.API.AddressResource · object[]
required
​
primary_address
App.Http.Resources.API.AddressResource · object
required
​
last_donation_amount
string
required
​
stats
object
required
​
tags
string
required
​
custom_fields
any[]
required
​
external_ids
ExternalIdResource · object[]
required
​
is_email_subscribed
string
required
​
is_phone_subscribed
string
required
​
is_address_subscribed
string
required
​
email_opt_in
string
required
​
sms_opt_in
string
required
​
address_unsubscribed_at
string
required
​
archived_at
string
required
​
created_at
string
required
​
updated_at
string
required
​
salutation_name
string
required
​
point_of_contact
PointOfContactResource · object
​
associated_companies
AssociatedCompanyResource · object[] | null