How to get users registered in form through API?

General
1

Is there any way to pull the users that have registered in a form from a divhunt api?

2

@Serpa

Do you mean form submissions?

3

Yes, from the form submissions I can access through the backoffice.

4

You’re in luck :slight_smile: We are releasing API today :slight_smile: Well, first part of it, but it will include forms!

I’ll let you know when it’s live!

5

nice! let me know plz.

6

@Serpa

You are first one who will use Divhunt API officially :slight_smile: Congratz, this is is huge!!!

  1. Go to Divhunt Dashboard
  2. Navigate to your project settings, then find the tab API Tokens
    image
    image1101Ă—592 46 KB
  3. Create token, name it like “Form Submissions”
  4. Go to token settings, and allow the GET endpoint forms.submission
    image
    image1082Ă—688 46.1 KB

Making the request:

  • Until we release documentation, which will be in next few days (it’s auto generated), you need to learn how to get full URL for each endpoint.
    image
    image707Ă—95 3.97 KB

So it’s domain + “/api” + add-on + endpoint

In this case GET https://your-domain.divhunt.art/api/admin/forms.submission

And along with request, you need to pass header Authorization with the token, which is provided, you can click on it to copy it.

image
image1267Ă—775 71.7 KB

Note: This request will ask you to provide ID, either as query param ?id= or as body JSON, the ID of form you can find in your admin panel, in form settings you can copy ID of form you need to get submissions.

Let me know if you had any success with this :slight_smile:

3 Likes
7

Hey @dejan!

Thanks for the detailed examples!

So, I’ve followed what you said, and I’m getting this error now.

$ curl -H "Authorization: Bearer xxxxxxx-7" "https://XXX.divhunt.art/api/admin/forms.submission?id=459"

{"success":false,"message":"Invalid action.","framework":{"mode":"app","time.connection":2.4,"time.database":8.3,"time.query":5.9,"time":"12.0"}}

I’ve added the permissions and such:

image
image950Ă—465 15.4 KB

Not sure if I’m missing anything.

8

@Serpa

Authorization without “Bearer” just the token.

9

@dejan

Thanks, I removed the Bearer and also added an s to the end of submission :slight_smile:

End result:

curl -H "Authorization: XXX-7" "https://xxx.divhunt.art/api/admin/forms.submissions?id=459"
10

@Serpa

Perfect :slight_smile: we will release documentation soon and add more endpoints (CMS).

11

@dejan

Thanks, just one more thing.

Will the submissions endpoint have a pagination or something like that when there is a great amount of data?

Also, can I delete the submissions through the API?

Thanks!

12

@Serpa

You use now both ?limit=100 and ?page=1 with GET submissions endpoint.

13

@Serpa

I’ve added an endpoint for removing form submissions.

DELETE https://your-domain.com/api/admin/forms.submission?id=ID-of-a-submission

Also I want to check with you if is fine to update first endpoint

FROM
GET https://your-domain.com/api/admin/forms.submissions?id=ID-of-a-form
TO
GET https://your-domain.com/api/admin/forms.submissions?form=ID-of-a-form

So essentially, we just change ?id to ?form, so it does not get confusing for people so they understand that they need to provide form ID and not submission ID.

Since you are the only one who uses this endpoint, let me know if we can make a change?

14

Hey @dejan !

Thanks for the info and for the check.

Yes, go ahead! I’ll change that in my app as well.

15

@Serpa

Updated! Please update on your side. Thanks.

Let me know if you need any endpoint and I will deliver one by one, you can request literally anything :smiley: at the end, API will cover 100% of your website data and actions.

2 Likes