List Contacts For Client

import requests
url = "https://app.brightmove.com/ATS/app/contact/list/1/query/"
payload = {}
headers = {"Content-Type": "application/json"}
response = requests.get(url, json=payload, headers=headers)
print(response.json())

[
  {
    "userGk": 987654321,
    "guid": "a1b2c3d4-e5f6-7890-abcd-1234567890ef",
    "salutation": {
      "id": 1,
      "name": "Mr."
    },
    "firstName": "John",
    "middleName": "A.",
    "lastName": "Doe",
    "nickname": "Johnny",
    "email": "john.doe@example.com",
    "workEmail": "j.doe@company.com",
    "type": {
      "id": 2,
      "name": "Employee"
    },
    "companyGk": 123456789,
    "companyName": "BrightMove Solutions",
    "companyGuid": "f1e2d3c4-b5a6-7890-cdef-0987654321ab",
    "createUserGk": 111222333,
    "modifyUserGk": 444555666,
    "username": "jdoe",
    "avatarUrl": "https://cdn.brightmove.com/avatars/jdoe.png",
    "timezoneId": 5,
    "localeId": 1033,
    "statusId": 1,
    "phones": [
      {
        "id": 1001,
        "phoneNumber": "+1-555-123-4567",
        "type": {
          "id": 1,
          "name": "Mobile",
          "sortOrder": 1,
          "choice": true
        },
        "userGk": 987654321
      },
      {
        "id": 1002,
        "phoneNumber": "+1-555-765-4321",
        "type": {
          "id": 2,
          "name": "Work",
          "sortOrder": 2,
          "choice": true
        },
        "userGk": 987654321
      }
    ],
    "primary": true,
    "createUser": {
      "userGk": 111222333,
      "guid": "11122233-4444-5555-6666-777788889999",
      "salutation": {
        "id": 2,
        "name": "Ms."
      },
      "firstName": "Alice",
      "middleName": "B.",
      "lastName": "Smith",
      "nickname": "Ally",
      "email": "alice.smith@brightmove.com",
      "workEmail": "a.smith@brightmove.com",
      "type": {
        "id": 3,
        "name": "Admin"
      },
      "companyGk": 123456789,
      "companyName": "BrightMove Solutions",
      "companyGuid": "f1e2d3c4-b5a6-7890-cdef-0987654321ab",
      "createUserGk": 0,
      "modifyUserGk": 0,
      "username": "asmith",
      "avatarUrl": "https://cdn.brightmove.com/avatars/asmith.png",
      "timezoneId": 5,
      "localeId": 1033,
      "statusId": 1,
      "displayFullName": "Alice B. Smith",
      "displayName": "Alice Smith",
      "displayNameLastFirst": "Smith, Alice",
      "bestEmail": "alice.smith@brightmove.com"
    },
    "modifyUser": {
      "userGk": 444555666,
      "guid": "44455566-7777-8888-9999-000011112222",
      "salutation": {
        "id": 1,
        "name": "Mr."
      },
      "firstName": "Bob",
      "middleName": "C.",
      "lastName": "Johnson",
      "nickname": "Bobby",
      "email": "bob.johnson@brightmove.com",
      "workEmail": "b.johnson@brightmove.com",
      "type": {
        "id": 3,
        "name": "Admin"
      },
      "companyGk": 123456789,
      "companyName": "BrightMove Solutions",
      "companyGuid": "f1e2d3c4-b5a6-7890-cdef-0987654321ab",
      "createUserGk": 0,
      "modifyUserGk": 0,
      "username": "bjohnson",
      "avatarUrl": "https://cdn.brightmove.com/avatars/bjohnson.png",
      "timezoneId": 5,
      "localeId": 1033,
      "statusId": 1,
      "displayFullName": "Bob C. Johnson",
      "displayName": "Bob Johnson",
      "displayNameLastFirst": "Johnson, Bob",
      "bestEmail": "bob.johnson@brightmove.com"
    },
    "createDate": "2023-11-01T09:15:00Z",
    "modifyDate": "2024-04-10T16:45:00Z",
    "themeGk": 10,
    "lookDate": "2024-04-15T12:00:00Z",
    "unsubscribeDate": null,
    "delegates": [],
    "emailSignature": "Best regards,\nJohn Doe\nBrightMove Solutions",
    "name": "John A. Doe",
    "displayFullName": "John A. Doe",
    "displayName": "John Doe",
    "displayNameLastFirst": "Doe, John",
    "bestEmail": "john.doe@example.com"
  }
]

Lookup a Contact by query within a Client

Path parameters

clientGklongRequired

querystringRequired

Path parameters

Headers

Response