Contacts

Supported contact attributes:

Attribute Type Description
id number Unique identifier of the contact.
creator_id number Unique identifier of the user who created the contact.
owner_id number Unique identifier of the user that the contact is assigned to.
is_organization boolean Indicator of whether or not this contact refers to an organization or an individual.
contact_id number The unique identifier of the organization the contact belongs to.
parent_organization_id number The unique identifier of an organization contact that is parent of this organization. The field will be set only if the contact is an organization and has parent.
name string Name of the contact. Required only if the contact is an organization.
first_name string First name of the contact.
last_name string Last name of the contact. Required only if the contact is an individual.
customer_status string The customer status of the contact. Possible values: none, current, past
prospect_status string The prospect status of the contact. Possible values: none, current
title string The contact's job title.
description string The contact's description.
industry string The contact's industry.
website string The contact's website address.
email string The contact's email address.
phone string The contact's phone number.
mobile string The contact's mobile phone number.
fax string The contact's fax number.
twitter string The contact's X (formerly Twitter) handle.
facebook string The contact's Facebook nickname.
linkedin string The contact's Linkedin nickname.
skype string The contact's Skype nickname.
address Address The contact's address. For more information about the address object see Address
billing_address Address The contact's billing address. For more information about the address object see Address
shipping_address Address The contact's shipping address. For more information about the address object see Address
tags array An array of tags for a contact. See more at Tag.
custom_field_values array An array of custom field values for a contact. See more at Custom Field Value.
created_at string Date and time that the contact was created in UTC (ISO8601 format).

Endpoints

Stream Contacts

Read the stream of contact events.

See Overview for more details on request and response formats and parameters.

Action

GET /v3/contacts/stream

Examples

Read the stream of contact events

GET /v3/contacts/stream?position=tailAccept: application/jsonAuthorization: Bearer $ACCESS_TOKENUser-Agent: $CLIENT_NAME
HTTP/1.1 200 OK       Content-Type: application/json
{ "items": [    {      "data": {        "owner_id": 190756,        "created_at": "2016-03-15T09:13:06Z",        "description": null,        "industry": null,        "billing_address": null,        "linkedin": null,        "title": "CEO",        "contact_id": 4513016,        "skype": null,        "twitter": null,        "shipping_address": null,        "id": 4255984,        "fax": null,        "is_organization": false,        "first_name": "ABC",        "email": "",        "prospect_status": "current",        "website": null,        "address": {          "country": "Poland",          "city": "KRK",          "state": "",          "postal_code": "",          "line1": "street 123"        },        "facebook": null,        "mobile": "",        "last_name": "XYZ",        "tags": [          {            "data": {              "name": "ABC",              "resource_type": "prospect_and_customer",              "id": 124234            },            "meta": {                "type": "tag"            }          }        ],        "custom_field_values": [          {            "value": false,            "custom_field": {                "data": {                  "name": "myField",                  "resource_type": "contact",                  "id": 29609,                  "type": "bool"                },                "meta": {                    "type": "custom_field"                }            }          }        ],        "phone": "",        "customer_status": "current",        "name": "ABC XYZ",        "creator_id": 190756      },      "meta": {        "event_id": "K7byizXCTACIlfOeMNqo3A",        "event_cause": "interaction",        "sequence": 24,        "event_time": "2016-08-22T15:14:23Z",        "event_type": "updated",        "previous": {          "title": "123"        },        "type": "contact",        "event_time": "2016-08-18T07:29:42Z"      }    }],  "meta": {    "links": {      "next": "https://api.getbase.com/v3/contacts/stream?position=ZmlyZWhvc2UuZmFjdG9pZC5jb250YWN0LnNuYXBzaG90cywxLDMwNTQ5Mg=="    },    "position": "ZmlyZWhvc2UuZmFjdG9pZC5jb250YWN0LnNuYXBzaG90cywxLDMwNTQ5Mg==",    "top": false  }}