Methods

  • post - Create a new contact item
  • get - Retrieve a single contact item
  • get - Retrieve contact items from contact list
  • put - Update an existing contact item

Resource

[
    {
        "attachments": [
            "string"
        ],
        "bcChecked": "boolean",
        "bcImage": "string",
        "bcImageBackside": "string",
        "bcImageBacksideLocal": "string",
        "bcImageLocal": "string",
        "city": "string",
        "contactListId": "string",
        "country": "string",
        "createdBy": "string",
        "customFields": {
            "<key>": {}
        },
        "drawing": "string",
        "email": "string",
        "facebook": "string",
        "fax": "string",
        "firstName": "string",
        "gender": "integer",
        "image": "string",
        "industry": "string",
        "lastName": "string",
        "linkedin": "string",
        "mobile": "string",
        "note": "string",
        "organization": "string",
        "phone": "string",
        "poBox": "string",
        "position": "string",
        "revenue": "string",
        "sequenceNumber": "number",
        "size": "string",
        "state": "string",
        "street": "string",
        "title": "string",
        "twitter": "string",
        "vat": "string",
        "website": "string",
        "xing": "string",
        "zip": "string"
    }
]

Properties

Name Type Description Additional
attachments[] array of string
bcChecked boolean
bcImage string
bcImageBackside string
bcImageBacksideLocal string
bcImageLocal string
city string
contactListId string

The id of the corresponding contact list a contact item belongs to.

country string
createdBy string Optional, read only.
customFields object
customFields.<key> map of object

This might be any viable JSON value.

Optional
drawing string
email string
facebook string
fax string
firstName string
gender integer

-1 (neutral), 0 (male) or 1 (female)

image string
industry string

LinkedIn industry code as defined here

lastName string
linkedin string
mobile string
note string
organization string
phone string
poBox string
position string
revenue string
sequenceNumber number

This is used to order items within a list (default: null -> appears on top)

Optional, read only.
size string

Possible values are:

  • 1-10
  • 11-50
  • 51-200
  • 201-500
  • 501-1000
  • 1001-5000
  • 5001-10000
  • 10000+
state string
street string
title string
twitter string
vat string
website string
xing string
zip string