GET
/
contacts
/
{id}
Get a contact
curl --request GET \
  --url https://api.smokeball.com/contacts/{id} \
  --header 'Authorization: <api-key>' \
  --header 'x-api-key: <api-key>'
{
  "href": "<string>",
  "relation": "<string>",
  "method": "GET",
  "self": {
    "id": "<string>",
    "href": "<string>",
    "relation": "<string>",
    "method": "GET"
  },
  "id": "b471682e-fa17-4e46-b7fe-9b2b8fdcb3c2",
  "externalSystemId": "EXT01",
  "versionId": "750eb5c5-ac0b-7d11-4997-e0ce9d8896c8",
  "person": {
    "title": "Mr",
    "firstName": "John",
    "middleName": "Michael",
    "lastName": "Smith",
    "nameSuffix": "PhD",
    "customName": "Johnny",
    "residentialAddress": {
      "careOf": "John Smith",
      "buildingLevel": "Level 1",
      "unitNumber": "10",
      "unitType": "Suite",
      "streetNumber": "100",
      "streetName": "Broad",
      "streetType": "Street",
      "addressLine1": "Level 1/10",
      "addressLine2": "100 Broad Street",
      "city": "Chicago",
      "state": "IL",
      "zipCode": "60606",
      "locality": "Dunkirk",
      "county": "New York",
      "country": "United States",
      "poBox": {
        "careOf": "John Smith",
        "poBoxType": "Locked Bag",
        "poBoxNumber": "12345",
        "city": "Chicago",
        "state": "IL",
        "zipCode": "60606"
      }
    },
    "mailingAddress": {
      "careOf": "John Smith",
      "buildingLevel": "Level 1",
      "unitNumber": "10",
      "unitType": "Suite",
      "streetNumber": "100",
      "streetName": "Broad",
      "streetType": "Street",
      "addressLine1": "Level 1/10",
      "addressLine2": "100 Broad Street",
      "city": "Chicago",
      "state": "IL",
      "zipCode": "60606",
      "locality": "Dunkirk",
      "county": "New York",
      "country": "United States",
      "poBox": {
        "careOf": "John Smith",
        "poBoxType": "Locked Bag",
        "poBoxNumber": "12345",
        "city": "Chicago",
        "state": "IL",
        "zipCode": "60606"
      }
    },
    "phone": {
      "areaCode": "555",
      "number": "1234567"
    },
    "phone2": {
      "areaCode": "555",
      "number": "1234567",
      "extension": "103"
    },
    "fax": {
      "areaCode": "555",
      "number": "1234567"
    },
    "cell": {
      "areaCode": "555",
      "number": "1234567"
    },
    "email": "john.smith@brown.com",
    "notes": "Prefers to answer work phone.",
    "occupation": "Bookkeeper",
    "gender": "Male",
    "maritalStatus": "Single",
    "specialNeeds": "Wheelchair access",
    "birthDate": "1980-07-01",
    "birthPlace": "Chicago",
    "birthState": "Illinois",
    "birthCountry": "USA",
    "identificationNumberType": "Passport",
    "identificationNumber": "PP123456789",
    "birthFirstName": "James",
    "birthMiddleName": "Thomas",
    "birthLastName": "Jones",
    "previousNames": "Jane Smith",
    "passportDetails": {
      "passportNumber": "AB123456",
      "passportIssueDate": "2010-08-01",
      "passportExpireDate": "2030-08-01",
      "passportIssueCountry": "USA",
      "passportIssueAuthority": "HM Passport Office"
    },
    "deathDetails": {
      "deathDate": "2020-08-01",
      "isDeathDateUnknown": false,
      "deathDateFrom": "2020-08-01",
      "deathDateTo": "2020-08-01",
      "deathPlace": "Chicago",
      "deathState": "IL",
      "deathCountry": "USA",
      "deathCounty": "San Bernardino County"
    },
    "correctionsReferenceNumber": "<string>",
    "centrelinkReferenceNumber": "<string>",
    "citizenshipDetails": {
      "countryOfCitizenship": "USA",
      "nationality": "American",
      "languageOfInterpreter": "French"
    },
    "utbmsDetails": {
      "ledesClientId": "<string>"
    }
  },
  "company": {
    "name": "Brown LLC",
    "type": "Corporation",
    "phone": {
      "areaCode": "555",
      "number": "1234567"
    },
    "fax": {
      "areaCode": "555",
      "number": "1234567"
    },
    "email": "contact@brown.com",
    "notes": "Construction company",
    "abn": "1234567890",
    "companyNumberType": "ACN",
    "companyNumber": "234567890",
    "mailingAddress": {
      "careOf": "John Smith",
      "buildingLevel": "Level 1",
      "unitNumber": "10",
      "unitType": "Suite",
      "streetNumber": "100",
      "streetName": "Broad",
      "streetType": "Street",
      "addressLine1": "Level 1/10",
      "addressLine2": "100 Broad Street",
      "city": "Chicago",
      "state": "IL",
      "zipCode": "60606",
      "locality": "Dunkirk",
      "county": "New York",
      "country": "United States",
      "poBox": {
        "careOf": "John Smith",
        "poBoxType": "Locked Bag",
        "poBoxNumber": "12345",
        "city": "Chicago",
        "state": "IL",
        "zipCode": "60606"
      }
    },
    "businessAddress": {
      "careOf": "John Smith",
      "buildingLevel": "Level 1",
      "unitNumber": "10",
      "unitType": "Suite",
      "streetNumber": "100",
      "streetName": "Broad",
      "streetType": "Street",
      "addressLine1": "Level 1/10",
      "addressLine2": "100 Broad Street",
      "city": "Chicago",
      "state": "IL",
      "zipCode": "60606",
      "locality": "Dunkirk",
      "county": "New York",
      "country": "United States",
      "poBox": {
        "careOf": "John Smith",
        "poBoxType": "Locked Bag",
        "poBoxNumber": "12345",
        "city": "Chicago",
        "state": "IL",
        "zipCode": "60606"
      },
      "dxAddress": {
        "number": "376",
        "exchange": "DX",
        "state": "NSW"
      }
    },
    "staff": [
      {
        "id": "<string>",
        "href": "<string>",
        "relation": "<string>",
        "method": "<string>"
      }
    ],
    "directors": [
      {
        "id": "<string>",
        "href": "<string>",
        "relation": "<string>",
        "method": "<string>"
      }
    ],
    "staffIds": [
      "<string>"
    ]
  },
  "trust": {
    "name": "Trinity Trust",
    "status": "as Trustee of",
    "trustNumber": "12345678",
    "executedDate": "1980-07-01",
    "phone": {
      "areaCode": "555",
      "number": "1234567"
    },
    "fax": {
      "areaCode": "555",
      "number": "1234567"
    },
    "address": {
      "careOf": "John Smith",
      "buildingLevel": "Level 1",
      "unitNumber": "10",
      "unitType": "Suite",
      "streetNumber": "100",
      "streetName": "Broad",
      "streetType": "Street",
      "addressLine1": "Level 1/10",
      "addressLine2": "100 Broad Street",
      "city": "Chicago",
      "state": "IL",
      "zipCode": "60606",
      "locality": "Dunkirk",
      "county": "New York",
      "country": "United States",
      "poBox": {
        "careOf": "John Smith",
        "poBoxType": "Locked Bag",
        "poBoxNumber": "12345",
        "city": "Chicago",
        "state": "IL",
        "zipCode": "60606"
      }
    },
    "trustees": [
      {
        "Name": "John Smith",
        "Type": "Individual"
      },
      {
        "Name": "Smithfield Steel",
        "Type": "Company"
      }
    ],
    "contacts": [
      {
        "id": "<string>",
        "href": "<string>",
        "relation": "<string>",
        "method": "<string>"
      }
    ]
  },
  "groupOfPeople": {
    "people": [
      {
        "id": "<string>",
        "href": "<string>",
        "relation": "<string>",
        "method": "<string>"
      }
    ],
    "residentialAddress": {
      "careOf": "John Smith",
      "buildingLevel": "Level 1",
      "unitNumber": "10",
      "unitType": "Suite",
      "streetNumber": "100",
      "streetName": "Broad",
      "streetType": "Street",
      "addressLine1": "Level 1/10",
      "addressLine2": "100 Broad Street",
      "city": "Chicago",
      "state": "IL",
      "zipCode": "60606",
      "locality": "Dunkirk",
      "county": "New York",
      "country": "United States",
      "poBox": {
        "careOf": "John Smith",
        "poBoxType": "Locked Bag",
        "poBoxNumber": "12345",
        "city": "Chicago",
        "state": "IL",
        "zipCode": "60606"
      }
    },
    "mailingAddress": {
      "careOf": "John Smith",
      "buildingLevel": "Level 1",
      "unitNumber": "10",
      "unitType": "Suite",
      "streetNumber": "100",
      "streetName": "Broad",
      "streetType": "Street",
      "addressLine1": "Level 1/10",
      "addressLine2": "100 Broad Street",
      "city": "Chicago",
      "state": "IL",
      "zipCode": "60606",
      "locality": "Dunkirk",
      "county": "New York",
      "country": "United States",
      "poBox": {
        "careOf": "John Smith",
        "poBoxType": "Locked Bag",
        "poBoxNumber": "12345",
        "city": "Chicago",
        "state": "IL",
        "zipCode": "60606"
      }
    },
    "name": "John Smith & Jane Citizen"
  },
  "isDeleted": true,
  "lastUpdated": 637847425252027400,
  "tags": [
    {
      "id": "<string>",
      "name": "<string>",
      "type": "Custom"
    }
  ]
}

Authorizations

​
x-api-key
string
header
required
​
Authorization
string
header
required

Path Parameters

​
id
string<uuid>
required

Response

When request is successful. Returns a 'Contact' object.

​
href
string | null
​
relation
string | null
​
method
string | null
default:GET
​
self
object
​
id
string | null

Unique identifier of the contact.

Example:

"b471682e-fa17-4e46-b7fe-9b2b8fdcb3c2"

​
externalSystemId
string | null

External system id for the contact.

Example:

"EXT01"

​
versionId
string | null

Version id of the record.

Example:

"750eb5c5-ac0b-7d11-4997-e0ce9d8896c8"

​
person
object

Contact person details (if applicable).

​
company
object

Contact company details (if applicable).

​
trust
object

Contact trust details (if applicable).

Note that Trust is only supported in the US. It is not available in other regions.

​
groupOfPeople
object

Contact group details (if applicable).

​
isDeleted
boolean

Returns true if the contact is deleted.

Example:

true

​
lastUpdated
integer

Last updated timestamp.

Example:

637847425252027400

​
tags
object[] | null

Set of contact's tags.