API Documentation

Authorization

Interaction with NetHunt CRM happens via HTTPS using GET and POST methods and the "application/json" media type for payload.

For "Basic" authentication the credentials are constructed by first combining the username (your email) and the password (your api key) with a colon (example@nethunt.com:c3e07232-05d3-40c6-a18b), and then by encoding the resulting string in base64 (ZXhhbXBsZUBuZXRodW50LmNvbTpjM2UwNzIzMi0wNWQzLTQwYzYtYTE4Yg==).

Operations

List all accessible folders

Sample request

Sample result

[
    {
        "id": "596f644b8f6d05e16c24b810",
        "name": "My first folder"
    },
    {
        "id": "596f644b8f6d05e16c24b811",
        "name": "My second folder"
    }
]
                

List folders which the user can create records in

Sample request

Sample result

[
    {
        "id": "596f644b8f6d05e16c24b810",
        "name": "My first folder"
    },
    {
        "id": "596f644b8f6d05e16c24b811",
        "name": "My second folder"
    }
]
                

List folder fields

Sample request

Sample result

[
    {
        "name": "Name"
    },
    {
        "name": "Birthday"
    },
    {
        "name": "Primary Email Address"
    }
]
                

Find records by ID or text query

Sample request

Sample result

[
    {
        "id": "596f644b8f6d05e16c24b830",
        "recordId": "596f644b8f6d05e16c24b830",
        "createdAt": "2015-01-01T12:34:15.880Z",
        "updatedAt": "2015-02-01T12:30:10.510Z",
        "fields": {
            "Name": "John Doe",
            "Birthday": "1980-01-01",
            "Employed": true,
            "Salary": 100000,
            "Keywords": [
                "Java",
                "Big Data"
            ],
            "Primary Email Address": "John Doe <john.doe@example.com>",
            "Other Email Addresses": [
                "J. Doe <j.doe@example.com>",
                "J. D. <j.d@example.com>"
            ],
            "Co-workers": [
                "596f64368f6d05e16c24b833",
                "596f644b8f6d05e16c24b834"
            ]
        }
    },
    {
        "id": "596f644b8f6d05e16c24b831",
        "recordId": "596f644b8f6d05e16c24b831",
        "createdAt": "2015-02-01T12:35:15.880Z",
        "fields": {
            "Name": "Jane Doe"
        }
    }
]
                

Find recently created records

Sample request

Sample result

[
    {
        "id": "596f644b8f6d05e16c24b830",
        "recordId": "596f644b8f6d05e16c24b830",
        "createdAt": "2015-01-01T12:34:15.880Z",
        "fields": {
            "Name": "John Doe",
            "Birthday": "1980-01-01",
            "Employed": true,
            "Salary": 100000,
            "Keywords": [
                "Java",
                "Big Data"
            ],
            "Primary Email Address": "John Doe <john.doe@example.com>",
            "Other Email Addresses": [
                "J. Doe <j.doe@example.com>",
                "J. D. <j.d@example.com>"
            ],
            "Co-workers": [
                "596f64368f6d05e16c24b833",
                "596f644b8f6d05e16c24b834"
            ]
        }
    },
    {
        "id": "596f644b8f6d05e16c24b831",
        "recordId": "596f644b8f6d05e16c24b831",
        "createdAt": "2015-02-01T12:35:15.880Z",
        "fields": {
            "Name": "Jane Doe"
        }
    }
]
                

Find recently created record comments

Sample request

Sample result

[
    {
        "id": "596f644b8f6d05e16c24b820",
        "commentId": "596f644b8f6d05e16c24b820",
        "recordId": "596f644b8f6d05e16c24b830",
        "createdAt": "2015-01-01T12:34:15.880Z",
        "text": "My first comment"
    },
    {
        "id": "596f644b8f6d05e16c24b821",
        "commentId": "596f644b8f6d05e16c24b821",
        "recordId": "596f644b8f6d05e16c24b831",
        "createdAt": "2015-01-01T14:34:15.880Z",
        "text": "My second comment"
    }
]
                

Find recently created call logs

Sample request

Sample result

[
   {
    "id": "60672149da70705e2d1767d4",
    "callLogId": "60672149da70705e2d1767d4",
    "recordId": "5f4e3f715d3e3a479a237fcb",
    "createdAt": "2021-04-02T13:51:05.852Z",
    "text": "Yet another sample",
    "time": "2021-04-02T13:50:00Z",
    "duration": 1,
    "endTime": "2021-04-02T13:51:00Z"
  },
  {
    "id": "60672138700c05119ef89344",
    "callLogId": "60672138700c05119ef89344",
    "recordId": "5f4e3f715d3e3a479a237fcb",
    "createdAt": "2021-04-02T13:50:48.414Z",
    "text": "Sample call log",
    "time": "2021-04-02T13:00:00Z",
    "duration": 1,
    "endTime": "2021-04-02T13:01:00Z"
  }
]
                

Find recently created Google Drive files

Sample request

Sample result

[
  {
    "id": "606725e6d778805d0c6ad358",
    "fileId": "606725e6d778805d0c6ad358",
    "folderId": "5e83adb7aafa736183219abf",
    "recordId": "5f4e3f715d3e3a479a237fcb",
    "createdAt": "2021-04-02T14:10:46.902Z",
    "googleDriveFileId": "1fzv5Uda_13RMxZCjc3HkUtIqGTLH0BjS",
    "description": "",
    "iconUrl": "https://ssl.gstatic.com/docs/doclist/images/icon_10_generic_list.png",
    "mimeType": "text/plain",
    "name": "1.txt",
    "url": "https://drive.google.com/file/d/1fzv5Uda_13RMxZCjc3HkUtIqGTLH0BjS/view?usp=drive_web"
  },
  {
    "id": "606725e6d778805d0c6ad359",
    "fileId": "606725e6d778805d0c6ad359",
    "folderId": "5e83adb7aafa736183219abf",
    "recordId": "5f4e3f715d3e3a479a237fcb",
    "createdAt": "2021-04-02T14:10:46.902Z",
    "googleDriveFileId": "10JHMcV4hqJvUQuqR1ZDlBMveYA9fBVWt",
    "description": "",
    "iconUrl": "https://ssl.gstatic.com/docs/doclist/images/icon_10_generic_list.png",
    "mimeType": "text/csv",
    "name": "2.csv",
    "url": "https://drive.google.com/file/d/10JHMcV4hqJvUQuqR1ZDlBMveYA9fBVWt/view?usp=drive_web"
  }
]
                

Find recently updated records

Sample request

Sample result

[
    {
        "id": "596f644b8f6d05e16c24b830-1500113235379",
        "recordId": "596f644b8f6d05e16c24b830",
        "createdAt": "2015-01-01T12:34:15.880Z",
        "updatedAt": "2015-02-01T12:30:10.510Z",
        "fields": {
            "Name": "John Doe",
            "Birthday": "1980-01-01",
            "Employed": true,
            "Salary": 100000,
            "Keywords": [
                "Java",
                "Big Data"
            ],
            "Primary Email Address": "John Doe <john.doe@example.com>",
            "Other Email Addresses": [
                "J. Doe <j.doe@example.com>",
                "J. D. <j.d@example.com>"
            ],
            "Co-workers": [
                "596f64368f6d05e16c24b833",
                "596f644b8f6d05e16c24b834"
            ]
        }
    },
    {
        "id": "596f644b8f6d05e16c24b831",
        "recordId": "596f644b8f6d05e16c24b831",
        "createdAt": "2015-02-01T12:35:15.880Z",
        "fields": {
            "Name": "Jane Doe"
        }
    }
]
                

Find recent record changes

Sample request

Sample result

[
    {
        "id": "597084cc39b70d3b5959c604",
        "recordId": "596f644b8f6d05e16c24b830",
        "time": "2017-03-01T12:30:10.510Z",
        "user": {
            "personalName": "Jane Doe",
            "emailAddress": "<jane.doe@example.com>"
        },
        "recordAction": "DELETE"
    },
    {
        "id": "597084cc39b70d3b5959c603",
        "recordId": "596f644b8f6d05e16c24b830",
        "time": "2015-03-01T12:30:10.510Z",
        "user": {
            "personalName": "Jane Doe",
            "emailAddress": "<jane.doe@example.com>"
        },
        "recordAction": "UPDATE",
        "fieldActions": {
            "Salary": {
                "remove": 100000,
                "add": 200000
            },
            "Keywords": {
                "remove": [
                    "Java"
                ],
                "add": [
                    "JavaScript"
                ]
            }
        }
    },
    {
        "id": "597084cc39b70d3b5959c602",
        "recordId": "596f644b8f6d05e16c24b830",
        "time": "2015-02-01T12:30:10.510Z",
        "user": {
            "personalName": "John Doe",
            "emailAddress": "<john.doe@example.com>"
        },
        "recordAction": "CREATE",
        "fieldActions": {
            "Name": {
                "add": "John Doe"
            },
            "Birthday": {
                "add": "1980-01-01"
            },
            "Employed": {
                "add": true
            },
            "Salary": {
                "add": 100000
            },
            "Keywords": {
                "add": [
                    "Java",
                    "Big Data"
                ]
            },
            "Primary Email Address": {
                "add": "John Doe <john.doe@example.com>"
            },
            "Other Email Addresses": {
                "add": [
                    "J. Doe <j.doe@example.com>",
                    "J. D. <j.d@example.com>"
                ]
            },
            "Co-workers": {
                "add": [
                    "596f64368f6d05e16c24b833",
                    "596f644b8f6d05e16c24b834"
                ]
            }
        }
    }
]
                

Create a new record

Sample request

{
    "timeZone": "Europe/London",
    "fields": {
        "Name": "John Doe",
        "Birthday": "1980-01-01",
        "Employed": true,
        "Salary": 100000,
        "Country": "GB",
        "Keywords": [
            "Java",
            "Big Data"
        ],
        "Primary Email Address": "John Doe <john.doe@example.com>",
        "Other Email Addresses": [
            "J. Doe <j.doe@example.com>",
            "J. D. <j.d@example.com>"
        ],
        "Co-workers": [
            "596f64368f6d05e16c24b833",
            "596f644b8f6d05e16c24b834"
        ]
    }
}
                

Sample result

{
    "recordId": "596f644b8f6d05e16c24b830",
    "createdAt": "2015-01-01T12:34:15.880Z",
    "fields": {
        "Name": "John Doe",
        "Birthday": "1980-01-01",
        "Employed": true,
        "Salary": 100000,
        "Country": "GB",
        "Keywords": [
            "Java",
            "Big Data"
        ],
        "Primary Email Address": "John Doe <john.doe@example.com>",
        "Other Email Addresses": [
            "J. Doe <j.doe@example.com>",
            "J. D. <j.d@example.com>"
        ],
        "Co-workers": [
            "596f64368f6d05e16c24b833",
            "596f644b8f6d05e16c24b834"
        ]
    }
}
                

Create a new record comment

Sample request

{
    "text": "It's a comment"
}
                

Sample result

{
    "commentId": "5970b408bbd55ad726e11bc3",
    "createdAt": "2015-01-01T12:34:15.880Z"
}
                

Create a new record call log

Sample request

{
    "text": "It's a call log",
    "time": "2015-01-01T12:35:00Z",
    "duration": 2.5
}
                

Sample result

{
    "callLogId": "5970b408bbd55ad726e11bc3",
    "createdAt": "2015-01-01T12:34:15.880Z"
}
                

Update a record

Sample request

{
    "fieldActions": {
        "Name": {
            "overwrite": true,
            "add": "John Doe"
        },
        "Salary": {
            "remove": 100000,
            "add": 200000
        },
        "Country": {
            "remove": "ES",
            "add": "GB"
        },
        "Keywords": {
            "remove": [
                "Java"
            ],
            "add": [
                "JavaScript"
            ]
        }
    }
}
                

Sample result

{
    "recordId": "596f644b8f6d05e16c24b830",
    "updatedAt": "2015-01-05T12:34:15.880Z",
    "fields": {
        "Name": "John Doe",
        "Birthday": "1980-01-01",
        "Employed": true,
        "Salary": 200000,
        "Keywords": [
            "Big Data",
            "JavaScript"
        ],
        "Primary Email Address": "John Doe <john.doe@example.com>",
        "Other Email Addresses": [
            "J. Doe <j.doe@example.com>",
            "J. D. <j.d@example.com>"
        ],
        "Co-workers": [
            "596f64368f6d05e16c24b833",
            "596f644b8f6d05e16c24b834"
        ]
    }
}
                

Delete a record

Sample request

Sample result

                {
                }
                

Add a Gmail thread to a record

Sample request

                {
                    "gmailThreadId": "1234567890abcdef"
                }
                

Sample result

                {
                }
                

Verify request credentials

Sample request

Sample result

[
    {
        "user": {
            "personalName": "John Doe",
            "emailAddress": "john.doe@example.com"
        }
    }
]
                

Country data format and requirements

We support a list of two-letter codes (ISO alpha-2), you can see the list of countries at this link.

Sample data

{
    "timeZone": "Europe/London",
    "fields": {
        "Name": "John Doe",
        "Birthday": "1980-01-01",
        "Country": "GB",
        "Country of birth": "UA"
    }
}