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.

Authentication

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:

All getsmart API requests must have a URL that follows this format:

https://survey.getsmartglobal.com/api/v1/project/{ProjectID}/{Action}

Each Action is associated with a different HTTP method.

Here is an overview of all available resources of the getsmart API with a link to know more about the technical details.

Test if the authentication is successful by calling the API Root of your project and leaving the Action empty as explained below.

Request

Response

Upload new invitation records on your project and automatically send them if wanted.

Request

[{"Name":"John Smith","Email":"john.smith@gmail.com"},{"Name":"Cristine Tee","Email":"cristine.tee@gmail.com"}]

[{"Name":"John Smith","Email":"john.smith@gmail.com","Language":"en_NZ"},{"Name":"Cristine Tee","Email":"cristine.tee@gmail.com"}]

[{"Name":"John Smith","Email":"john.smith@gmail.com","Language":"en_NZ"},{"Name":"Cristine Tee","Email":"cristine.tee@gmail.com","Language":"fr_FR"}]

[{"Name":"John Smith","Email":"john.smith@gmail.com","Language":"en_NZ","Answers":{"12345":{"Answer":"4","Comment":"Good Times!"}}},{"Name":"Cristine Tee","Email":"cristine.tee@gmail.com","Language":"fr_FR"}]

[{"Name":"John Smith","Email":"john.smith@gmail.com","Language":"en_NZ","Answers":{"12345":{"Answer":"4","Comment":"Good Times!"}}},{"Name":"Cristine Tee","Email":"cristine.tee@gmail.com","Language":"fr_FR","Answers":{"12345":{"Flag":1}}}]

Response

{"Upload":{"Counts":{"Request":3,"Success":3,"Fail":0}}}

{"Upload":{"Counts":{"Request":3,"Success":2,"Fail":1},"RecordErrors":[{"Index":2,"Errors":["'Name' not found.","'Email' is invalid."]}]}}

{"Upload":{"Counts":{"Request":3,"Success":3,"Fail":0}},"Send":{"Counts":{"Request":3,"Success":3,"Fail":0}}}

{"Upload":{"Counts":{"Request":3,"Success":3,"Fail":0}},"Send":{"Counts":{"Request":3,"Success":1,"Fail":2}}}

{"Upload":{"Counts":{"Request":3,"Success":2,"Fail":1},"RecordErrors":[{"Index":2,"Errors":["'Name' not found.","'Email' is invalid."]}]},"Send":{"Counts":{"Request":2,"Success":2,"Fail":0}}}

{"Upload":{"Counts":{"Request":3,"Success":2,"Fail":1},"RecordErrors":[{"Index":2,"Errors":["'Name' not found.","'Email' is invalid."]}]},"Send":{"Counts":{"Request":2,"Success":1,"Fail":1}}}

{"Message":"JSON is empty."}

{"Upload":{"Counts":{"Request":3,"Success":0,"Fail":3},"RecordErrors":[{"Index":0,"Errors":["'Language' is an empty string."]},{"Index":1,"Errors":["'222' is not a set."]},{"Index":2,"Errors":["'Name' not found.","'Email' is invalid."]}]}}