Softr Docs
Search…
API Settings
Softr API key generation and available endpoints
In this section of My Account, you can generate an API key for your Softr account to be used when interacting with the API endpoints. Let's first see how you can generate the key, and then we'll review the available endpoints and provide API call examples.

Generating an API Key

When you first enter the API Settings section in your account, you'll see a Generate API key button.
Generate API Key
As soon as you hit the button, the generated API key will appear. Here, you can View, Copy, Regenerate, or Delete the key.
API Key actions
That's it. Now you have your API key that you can use when interacting with your Softr apps through the API. Let's proceed to see what endpoints are available.
Make sure to have your Softr app published before making API calls.

API Endpoints

Create User

This endpoint allows creating a user inside the specified Softr app within your account. Below is an example of an API call.
1
curl --request POST 'https://studio-api.softr.io/v1/api/users' \
2
--header 'Softr-Api-Key: uYGskr7MqMeRYrjQjsB8uEQ8n' \
3
--header 'Softr-Domain: yourdomain.com' \
4
--header 'Content-Type: application/json' \
5
--data-raw '{
6
"full_name": "John Richardson",
7
"email": "[email protected]",
8
"password": "12345678",
9
"generate_magic_link":true
10
}'
Copied!
Here, you need to replace the value next to Softr-Api-Key with your API key you've generated and add your Softr app's domain/subdomain instead of yourdomain.com.
Next, you need to provide the Full Name of the new user along with an Email and Password (replace the values next to full_name, email, and password).
If you don't specify a password, it will be generated for the user automatically.
Finally, you can set the value of generate_magic_link to "true" or "false" depending on whether you want to generate a Magic Link for the user or not.

Delete User

Using this endpoint, you can delete a user from the specified Softr app. Bellow is an example of an API call.
1
curl --location --request DELETE 'https://studio-api.softr.io/v1/api/users/[email protected]' \
2
--header 'Softr-Api-Key: pYSskw7MqMeRUgjQtsf9uRQ5n' \
3
--header 'Softr-Domain: yourdomain.com'
Copied!
Just replace [email protected] with the actual email of the user you need to delete as well as provide your API key (the value next to Softr-Api-Key) and the domain/subdomain of the Softr app (the value next to Softr-Domain) you want to delete the user from. The rest needs to remain the same as in the example.

Possible Use Cases

There are certainly a lot of different use cases for interacting with the Softr API. But if you're working with no-code tools, you can make API calls with such tools as Zapier or Integromat. Below, we consider some use cases involving Zapier and Integromat to take you through the setup process.

Use Case: Adding Users through Zapier

Let's see how you can use the API to add users via Zapier. In this example, we are going to sync a Softr App with Google Sheets, but this is just for demonstration purposes, and we wouldn't recommend storing sensitive data (e.g. passwords) on Google Sheets in real life. So, let's start.

Step 1: Setting the Trigger

First of all, we're going to create a spreadsheets with Name, Email, and Password columns to store user data.
Users sheet
Further on, we'll create a Zap on Zapier and set the trigger for each new row creation in our Google sheet. See below.
Setting the trigger
Next, we'll test the trigger and proceed to configuring the Action to define what's going to happen when the initial event is triggered.

Step 2: Configuring the Action

In the Action search bar enter "webhook" and select Webhooks by Zapier (please note that this is a paid feature).
Selecting Webhooks by Zapier
In the following screen, we need to select POST as the Action event since we need to create a user using the POST request as described above.
In the next screen, we need to fill in all the necessary details based on the create user endpoint. Thus, we need to set the URL to "https://studio-api.softr.io/v1/api/users", set the Payload Type to "json", and map the data as shown below.
URL, Payload Type, and Data Mapping
The following configs can be left intact, and we just need to add the headers using our API key and domain as shown below.
Headers configured

Step 3: Testing the Action

That's it. Now, we just need to hit Continue and test the action. As you can see below, as soon as we do the test, the user we had added earlier on Google Sheets is added to our Softr app. So, as soon as you make sure it's working correctly, you can turn on the Zap to start the automation.
Testing the Action

Deleting a User

The delete request can be implemented in a similar way through a custom webhook.

Use Case: Adding Users through Integromat

In this use case, we are going to use the API to add users to a Softr app via Integromat. We are going to add users on Google Sheets and send them to Softr (this is solely for demonstration purposes, and we don't recommend storing user data on Google Sheets or similar sources). Let's proceed.

Step 1: Setting a Trigger

First of all, we're going to create a spreadsheets with Name, Email, and Password columns to store user data.
Users sheet
Then we'll go to Integromat dashboard, create a new scenario, and add a trigger that watches for new rows on our selected sheet. See below.
Creating the trigger
Note that we're also setting the Row with headers according to our sheet (A1:C1).

Step 2: Configuring the Action

Next, we need to create a new module, search for HTTP, select it, and choose the Make a request action.
Selecting the action
Now, let's start configuring the module based on our endpoint. First we need to add our URL, then select the method (POST), and finally add the required headers. We don't need to add the Content-Type header, as it's going to be added in the next step. You can see how it looks like below.
Configuring URL, Method, and Headers
Further on, we need to set the Body Type to Raw and the Content Type to JSON. Lastly, we are going to fill in the Request Content using the format provided above. Please note that the Parse response option should be checked.
Configuring Body and Content types and adding Request content

Step 3: Testing the Scenario

So, we're almost there. Let's just add a new row in our sheet and run the scenario to test it. As, you can see below, the user is successfully added to our Softr app.
Testing the Scenario

Deleting a User

The delete request can be implemented in a similar way through an HTTP (Make a request) module.
​
​
​
​
​
Last modified 1mo ago