Before launching our oauth service, the recommended approach is to create a user in the office and provide the appropriate permissions (scope) for your plans.

Then, obtain a token via the POST api/auth/authenticate endpoint:

In your own applications, the token should be used as a bearer token in your requests in the Authorization header. Example:

                await api.request({
                    method: this.method,
                    url: this.route + this.query,
                    headers: {
                        'Content-Type': 'application/json,
                        'Authorization': 'Bearer ' + this.token
                    },
                    data: this.payload
                })
            

Keep in mind that the token should never be accessible to a client/browser.

Let's assume a scenario where you want to add a guest to an existing event you created via the app. The corresponding endpoint is: POST api/guest/:eventUuid. To obtain the eventUuid, you can use the GET api/events?search={Event name} endpoint.

                await api.request({
                    method: "GET",
                    url: "api/events?search=Taco%20Party%202025",
                    headers: {
                        'Content-Type': 'application/json,
                        'Authorization': 'Bearer ' + this.token
                    }
                })
            

You will receive a paginated result containing the eventUuid.

Now you can add your guest to the event:

                await api.request({
                    method: "POST",
                    url: "api/guest/" + eventUuid,
                    headers: {
                        'Content-Type': 'application/json,
                        'Authorization': 'Bearer ' + this.token
                    },
                    data: {
                        email: 'guest@example.com',
                        name: 'John Doe'
                    }
                })
            

That's it! Try it out: To the docs.

If you want to retrieve guest data from an event, you can use GET api/guests/:eventUuid.

                await api.request({
                    method: "GET",
                    url: "api/guests/" + eventUuid,
                    headers: {
                        'Content-Type': 'application/json,
                        'Authorization': 'Bearer ' + this.token
                    }
                })
            

You will receive a list of all guests as well as their various timestamps.

That's it! Try it out: To the docs.