Get a contact

Retrieves a specified contact.

GET /contacts/{id}

Get a contact

cURL

curl --request GET \
  --url https://api.smokeball.com/contacts/{id} \
  --header 'Authorization: <api-key>' \
  --header 'x-api-key: <api-key>'

import requests

url = "https://api.smokeball.com/contacts/{id}"

headers = {
    "x-api-key": "<api-key>",
    "Authorization": "<api-key>"
}

response = requests.get(url, headers=headers)

print(response.text)

const options = {method: 'GET', headers: {'x-api-key': '<api-key>', Authorization: '<api-key>'}};

fetch('https://api.smokeball.com/contacts/{id}', options)
  .then(res => res.json())
  .then(res => console.log(res))
  .catch(err => console.error(err));

<?php

$curl = curl_init();

curl_setopt_array($curl, [
  CURLOPT_URL => "https://api.smokeball.com/contacts/{id}",
  CURLOPT_RETURNTRANSFER => true,
  CURLOPT_ENCODING => "",
  CURLOPT_MAXREDIRS => 10,
  CURLOPT_TIMEOUT => 30,
  CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
  CURLOPT_CUSTOMREQUEST => "GET",
  CURLOPT_HTTPHEADER => [
    "Authorization: <api-key>",
    "x-api-key: <api-key>"
  ],
]);

$response = curl_exec($curl);
$err = curl_error($curl);

curl_close($curl);

if ($err) {
  echo "cURL Error #:" . $err;
} else {
  echo $response;
}

package main

import (
	"fmt"
	"net/http"
	"io"
)

func main() {

	url := "https://api.smokeball.com/contacts/{id}"

	req, _ := http.NewRequest("GET", url, nil)

	req.Header.Add("x-api-key", "<api-key>")
	req.Header.Add("Authorization", "<api-key>")

	res, _ := http.DefaultClient.Do(req)

	defer res.Body.Close()
	body, _ := io.ReadAll(res.Body)

	fmt.Println(string(body))

}

HttpResponse<String> response = Unirest.get("https://api.smokeball.com/contacts/{id}")
  .header("x-api-key", "<api-key>")
  .header("Authorization", "<api-key>")
  .asString();

require 'uri'
require 'net/http'

url = URI("https://api.smokeball.com/contacts/{id}")

http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true

request = Net::HTTP::Get.new(url)
request["x-api-key"] = '<api-key>'
request["Authorization"] = '<api-key>'

response = http.request(request)
puts response.read_body

200

{
  "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",
    "otherNames": "<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"
      }
    },
    "phone": {
      "areaCode": "555",
      "number": "1234567"
    },
    "phone2": {
      "areaCode": "555",
      "number": "1234567",
      "extension": "103"
    },
    "fax": {
      "areaCode": "555",
      "number": "1234567"
    },
    "cell": {
      "areaCode": "555",
      "number": "1234567"
    },
    "email": "[e-mail]",
    "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>"
    },
    "executionOptions": {
      "poaType": "Enduring",
      "poaDate": "2023-05-15",
      "attorneyName": "Jane Doe",
      "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"
        }
      },
      "poaRegisteredBook": "<string>",
      "poaRegisteredNumber": "<string>",
      "executionType": "PowerOfAttorney",
      "poaVoiDetails": {
        "isCompleted": true,
        "completedDateTime": "2024-01-15T10:30:00Z",
        "reference": "12345678",
        "source": "InfoTrackID",
        "status": "Complete"
      }
    },
    "voiDetails": {
      "isCompleted": true,
      "completedDateTime": "2024-01-15T10:30:00Z",
      "reference": "12345678",
      "source": "InfoTrackID",
      "status": "Complete"
    }
  },
  "company": {
    "name": "Brown LLC",
    "type": "Corporation",
    "phone": {
      "areaCode": "555",
      "number": "1234567"
    },
    "fax": {
      "areaCode": "555",
      "number": "1234567"
    },
    "email": "[e-mail]",
    "website": "https://www.brownllc.com",
    "notes": "Construction company",
    "abn": "1234567890",
    "ein": "<string>",
    "registeredDate": "2023-11-07T05:31:56Z",
    "stateId": "<string>",
    "stateRegisteredIn": "<string>",
    "countryRegisteredIn": "<string>",
    "branch": "<string>",
    "registeredAddress": {
      "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"
      }
    },
    "firmIsRegisteredAgent": true,
    "companyManagedBy": "<string>",
    "companyNumberType": "ACN",
    "companyNumber": "234567890",
    "doingBusinessAsName": "Brown Holdings",
    "tradingAs": "Trading As",
    "tradingName": "Brown Trading Co",
    "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": "GET"
      }
    ],
    "directors": [
      {
        "id": "<string>",
        "href": "<string>",
        "relation": "<string>",
        "method": "GET"
      }
    ],
    "staffIds": [
      "<string>"
    ],
    "executionOptions": {
      "person1": {
        "name": "John Smith",
        "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"
          }
        },
        "personType": "Director",
        "selectedOfficeHeld": "Director",
        "voiDetails": {
          "isCompleted": true,
          "completedDateTime": "2024-01-15T10:30:00Z",
          "reference": "12345678",
          "source": "InfoTrackID",
          "status": "Complete"
        }
      },
      "person2": {
        "name": "John Smith",
        "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"
          }
        },
        "personType": "Director",
        "selectedOfficeHeld": "Director",
        "voiDetails": {
          "isCompleted": true,
          "completedDateTime": "2024-01-15T10:30:00Z",
          "reference": "12345678",
          "source": "InfoTrackID",
          "status": "Complete"
        }
      },
      "executingUnder127": true,
      "executingAuthority": "<string>",
      "sealType": "WithSeal",
      "authorisedDepositTakingInstitution": true,
      "poaRegistrationNumber": "<string>",
      "attorneyNames": [
        "<string>"
      ],
      "executionType": "JointDirectors"
    }
  },
  "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": "GET"
      }
    ]
  },
  "groupOfPeople": {
    "people": [
      {
        "id": "<string>",
        "href": "<string>",
        "relation": "<string>",
        "method": "GET"
      }
    ],
    "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"
    }
  ]
}

{
  "type": "<string>",
  "title": "<string>",
  "status": 123,
  "detail": "<string>",
  "instance": "<string>"
}

{
  "type": "<string>",
  "title": "<string>",
  "status": 123,
  "detail": "<string>",
  "instance": "<string>"
}

Authorizations

x-api-key · string · header · required

Authorization · string · header · required

Path Parameters

id · string<uuid> · required

Response

200

application/json

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

href · string | null

relation · string | null

method · string | null · default: GET

self · object | null

Show child attributes

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 | null

Contact person details (if applicable).

Show child attributes

company · object | null

Contact company details (if applicable).

Show child attributes

trust · object | null

Contact trust details (if applicable).

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

Show child attributes

groupOfPeople · object | null

Contact group details (if applicable).

Show child attributes

isDeleted · boolean

Returns true if the contact is deleted.

Example:

true

lastUpdated · integer<int64>

Last updated timestamp.

Example:

637847425252027400

tags · object[] | null

Set of contact's tags.

Show child attributes