Introduction
What the Tepez API does, the objects it works with, and where to start.
The Tepez API connects your systems to your Tepez forms. Your system can prefill a form for a specific person, send them a link to fill it in, and read the finished entry and its PDF once they submit it. This page explains how Tepez fits into your process and which objects the API works with.
What Tepez does, and what your system does
Tepez handles forms. Its vocabulary is forms (טפסים) and entries (רשומות). It has no concept of employees, customers, products or branches. Those belong to your system.
So in an integration, your system holds the business logic:
- who may start a process, and when
- which values to prefill, from the data your system already has
- what happens with the result: reports, follow-up steps, storing it next to your own records
Tepez handles the form itself:
- it presents the form to the person filling it and stores what they enter
- it validates each value against the form's rules
- it captures signatures
- it produces a PDF of each submission and sends the emails, as the form defines them
Core objects
| Object | What it is |
|---|---|
| Account | Your organization in Tepez. Every other object belongs to exactly one account, and you can only reach the objects of your own account. |
| User | A person, or a service identity for an integration, who signs in to your account. Every user of an account has the same permissions. API keys belong to a user. |
| Form | A form's definition: its fields and layout, validation rules, email rules, PDF templates, and what the filler sees after submitting. |
| Entry | One filling of a form, also called a submission or response. It holds the filled data and its metadata: status (for example saved or submitted), timestamps, the actions performed on it, the emails sent and the PDFs produced. A form has many entries. |
| Template entry | An entry kept as a prefilled starting point. Each new entry started from its link begins with a copy of the template's data, and filling it leaves the template untouched. |
| Options set | A named list of options, such as cities or banks, that a select field can search as the person types. |
Requests and responses
All requests go to one base URL:
https://api.tepez.co.il/v1.0Every request and response body is JSON, and every request uses HTTPS. Each request authenticates
with an API key in the x-api-key header. Authentication explains how
to get a key and keep it safe.
When a request fails, the response says why, as Errors explains. Request sizes, page sizes and link lifetimes are listed in Limits.
The API reference lists every endpoint with its parameters and response schema. Sign in with your Tepez user to open it.
Start here
Quickstart
Get an API key and read your first entry in five minutes.
Authentication
API keys, login tokens and fill links, and how to keep them safe.
Prefill a form
Open a form with values your system already knows.
Get notified
React in your system when someone submits a form.
Query and export entries
Filter a form's entries, page through them, and export them to CSV, Excel or PDF.
Download PDFs and files
Download entries' PDFs and uploaded files, and keep a local copy of everything a form collects.
API reference
Every endpoint, parameter and response schema.
Looking for the Ovdim.IO API? It has its own documentation.
Question about this page? Email support@tepez.co.il