With the getsmart API, you can upload and send new invitations on your project.

More functionalities will be added in the future to allow you to interact fully with your data.

Before You Start

All getsmart API requests require the following details:

  • Username
    The username or email you use to login to your getsmart account.
  • Project ID
    The unique ID number of your project.
  • Project API Key
    The 32 characters long hexadecimal number of your project.

You will find this information on your getsmart account but remember to select the right project first from the top left dropdown menu.


The getsmart API uses the HTTP Basic Authentication. It uses your Username as the username and your Project API Key as the password.

HTTP Methods

The getsmart API supports 2 HTTP methods for interacting with your project:

  • GET
    Make a GET request to retrieve data. For example, use a GET request to test the authentication of your project.
    GET requests will never cause an update or change to your data because they are safe and idempotent.
  • POST
    Use a POST request to create new records or update existing records.
    For example, make a POST request to upload new invitations where the body of your request is a JSON formatted list of names and email addresses.


We give a valid, signed certificate for all API methods.
If you’re manually coding submit URLs, change HTTP to HTTPS in the URL, and make sure your connection library supports HTTPS.


The getsmart API only supports JSON.
The API Reference includes complete examples but here is a quick look at the JSON format of a POST request to upload new invitations:

        "Name": "John Smith",
        "Email": "john.smith@gmail.com",
        "Language": "en_NZ",
        "Answers": {
            "12345": {
                "Answer": "4",
                "Comment": "I had a good time."
        "Name": "Cristine Tee",
        "Email": "cristine.tee@gmail.com",
        "Language": "fr_FR",
        "Answers": {
            "26": {
                "Answer": "1"


For a POST request, you may need to include a request body in JSON format.

Every API call response includes headers and an optional JSON-formatted body.