API v1

Documentation on our public API version v1

You can automate once.to actions by using our public API. You can also integrate once.to with third-party services like Zapier.

The once.to API is following the REST principles. Our API has predictable resource-oriented URLs, which accept and return JSON-encoded responses.

API key

Our API uses API keys to authenticate requests. You can manage your API keys in your Profile.

Once you have the key, you can make requests to the public API endpoints, which look like this:

GET https://once.to/api/public/v1/auth

Every request you make to the API must be authenticated using the X-Api-Key header.

Here’s an example for curl:

$ curl -H 'X-Api-Key: YpIpi4O7Syazo5KsutSkqRFUiLuxnDmd2cJSrXstWoq3gBUawxXagGBzWOvz_gW90HiczZXBR3sJlbv3rzOjhCRIl5zgfIyMOkvAO2S5U1I' \

Response (pretty-formatted):

    "id": "7c1eacf1-373e-4360-a7fc-c62f7f9f881b",
    "isTeam": false,
    "email": "john@doe.org",
    "name": "John Doe"


For registered actors, the identifier of the external system must be included in the request using the X-Actor header.

API reference