Skip to main content
GET
/
contacts
Return a list of contacts
curl --request GET \
  --url https://api.givebutter.com/v1/contacts \
  --header 'Authorization: Bearer <token>'
{
  "data": [
    {
      "id": "<string>",
      "external_id": "<string>",
      "type": "<string>",
      "prefix": "<string>",
      "first_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"
      },
      "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>",
      "preferred_name": "<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>",
          "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>",
          "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>"
        }
      ]
    }
  ],
  "links": {
    "first": "<string>",
    "last": "<string>",
    "prev": "<string>",
    "next": "<string>"
  },
  "meta": {
    "current_page": 2,
    "from": 2,
    "last_page": 2,
    "links": [
      {
        "url": "<string>",
        "label": "<string>",
        "active": true
      }
    ],
    "path": "<string>",
    "per_page": 1,
    "to": 2,
    "total": 1
  }
}

Authorizations

Authorization
string
header
required

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

Query Parameters

type
enum<string>
Available options:
individual,
company
createdAfter
string<date-time> | null
createdBefore
string<date-time> | null
updatedAfter
string<date-time> | null
updatedBefore
string<date-time> | null
totalContributionsMin
number | null
totalContributionsMax
number | null
recurringContributionsMin
number | null
recurringContributionsMax
number | null
tags
string | null
sortBy
enum<string> | null
Available options:
name_or_company,
primary_email,
point_of_contact,
created_at,
total_contributions,
recurring_contributions
sortByDesc
enum<string> | null
Available options:
name_or_company,
primary_email,
point_of_contact,
created_at,
total_contributions,
recurring_contributions

Response

Paginated set of ContactResource

data
ContactResource · object[]
required
meta
object
required