API Reference

Authentication

To authenticate your API requests, you need to create a token. Once you have a token, include it in the Authorization header, using the Token scheme:

            Authorization: Token 0123456789abcdefghijklmnopqrstuvwxyz0123456789abcdefghijklmnopqr
        

Endpoints

Data Captures

List Data Captures

This endpoint returns the last 50 data captures. They are sorted by ID in descending order.

The list of data captures is contained in the _embedded.captures field.

Each capture contains links in the _links field. There's currently only one link — to purge personal information.

The whole response itself also contains links in the _links field.

The self link provides the URL of the current request in the href field.

The next link provides the URL to get the next set of data captures in the href field. Using the provided URLs, you can iterate through all the data captures. Once you've iterated through all of them, the whole link will become null — not just its href field.

It's important that you use this link instead of building the URL manually to avoid breaking your code if the pagination format changes.

https://api.simplebooth.com/api/data-captures

Responses

{
  "_embedded": {
    "captures": [
      {
        "id": 1,
        "firstName": "John",
        "lastName": "Doe",
        "emailAddress": "john.doe@example.com",
        "phoneNumber": "+1234567890",
        "zipCode": "12345",
        "birthdate": "1970-01-01",
        "public": true,
        "termsOfServiceAccepted": true,
        "privacyPolicyAccepted": true,
        "createdAt": "2000-01-01T00:00:00.000Z",
        "_embedded": {
          "upload": {
            "code": "6cW4Zav",
            "width": 0,
            "height": 0,
            "mimeType": "image/jpeg",
            "layout": "1x1",
            "public": false,
            "approved": false,
            "createdAt": "2025-04-16T18:23:45.000+00:00",
            "processed": false,
            "deleted": false,
            "media": {
              "original": "https://cdn.simplebooth.com/u/6cW4Zav.jpg",
              "medium": "https://cdn.simplebooth.com/u/6cW4Zav_m.jpg",
              "thumbnail": "https://cdn.simplebooth.com/u/6cW4Zav_sm.jpg",
              "facebookPreview": "https://cdn.simplebooth.com/u/6cW4Zav.jpg"
            },
            "_embedded": [],
            "_links": {
              "web:self": {
                "href": "https://www.simplebooth.com/pic/6cW4Zav"
              },
              "web:short": {
                "href": "https://smplbth.co/6cW4Zav"
              }
            }
          },
          "preset": {
            "id": 2,
            "title": "Party",
            "_embedded": {
              "gallery": {
                "id": 3,
                "title": "Party"
              }
            }
          },
          "device": {
            "name": "iPad"
          },
          "customFieldResponses": [
            {
              "_embedded": {
                "field": {
                  "dataType": "boolean",
                  "label": "Are you sure?"
                }
              },
              "value": true
            },
            {
              "_embedded": {
                "field": {
                  "dataType": "string",
                  "label": "How's it going?"
                }
              },
              "value": "Awesome"
            }
          ]
        },
        "_links": {
          "purge-personal-information": {
            "href": "https://api.simplebooth.com/api/data-captures/1/personal-information"
          }
        }
      },
      ...
    ]
  },
  "_links": {
    "self": {
      "href": "https://api.simplebooth.com/api/data-captures"
    },
    "next": {
      "href": "https://api.simplebooth.com/api/data-captures?after=1"
    }
  }
}

Purge Personal Information

This endpoint purges personal information of the data capture with the specified {id}.

https://api.simplebooth.com/api/data-captures/{id}/personal-information

Responses

13 May 2025