Get contacts

Returns a list of contacts.

GET /contacts

Get contacts

cURL

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

200

{
  "id": "<string>",
  "href": "<string>",
  "relation": "<string>",
  "method": "GET",
  "self": {
    "id": "<string>",
    "href": "<string>",
    "relation": "<string>",
    "method": "GET"
  },
  "value": [
    {
      "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": "[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]",
        "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": "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"
        }
      ]
    }
  ],
  "offset": 123,
  "limit": 123,
  "size": 123,
  "first": {
    "id": "<string>",
    "href": "<string>",
    "relation": "<string>",
    "method": "GET"
  },
  "previous": {
    "id": "<string>",
    "href": "<string>",
    "relation": "<string>",
    "method": "GET"
  },
  "next": {
    "id": "<string>",
    "href": "<string>",
    "relation": "<string>",
    "method": "GET"
  },
  "last": {
    "id": "<string>",
    "href": "<string>",
    "relation": "<string>",
    "method": "GET"
  }
}

Authorizations

x-api-key · string · header · required

Authorization · string · header · required

Query Parameters

Offset · integer<int32>

Required range: 0 <= x <= 2147483647

Limit · integer<int32>

Required range: 1 <= x <= 500

UpdatedSince · integer<int64>

Returns contacts updated since a specified time (.net ticks representation of the UTC datetime).

ExcludeDeletedContacts · boolean

Excludes (filters out) deleted contacts if set to true.

Example:

true

Type · string[]

Filters result by one more contact types if set. Returns all contact types by default. Possible values: Staff, Person, Organisation, GroupOfPeople, Trust

Search · string[]

Available fields: email, phone, name

Sort · string

Available fields: lastUpdated

Fields · string

Available fields: passportDetails, deathDetails, citizenshipDetails, utbmsDetails, tags, executionOptions, voiDetails

Response

200 - application/json

When request is successful. Returns a paged collection of 'Contact' objects.

id · string | null

href · string | null

relation · string | null

method · string | null · default: GET

self · object

Show child attributes

value · object[] | null

Show child attributes

offset · integer<int32> | null

limit · integer<int32> | null

size · integer<int64>

first · object

Show child attributes

previous · object

Show child attributes

next · object

Show child attributes

last · object

Show child attributes