Endpoints
List endpoints
API Documentation
- Authentication
- Endpoints
- Keys
- Submissions
- Errors
Endpoints
List endpoints
GET
/
v1
/
endpoints
curl --request GET \
--url https://api.formizee.com/v1/endpoints \
--header 'Authorization: Bearer <token>'{
"_metadata": {
"page": 1,
"totalPages": 2,
"itemsPerPage": 100
},
"endpoints": [
{
"id": "enp_4VjHrJoEwAFC6itz8oUBW9NW2bia",
"workspaceId": "ws_4VjHrJoEwAFC6itz8oUBW9NW2bia",
"slug": "my-endpoint",
"name": "My Endpoint",
"isEnabled": true,
"emailNotifications": false,
"redirectUrl": "https://example.com/thanks-you",
"targetEmails": [
"[email protected]",
"[email protected]"
],
"icon": "bolt",
"color": "pink"
}
]
}Authorizations
Bearer authentication header of the form Bearer <token>, where <token> is your auth token.
Query Parameters
Required range:
x >= 1Required range:
x >= 1Response
200
application/json
Retrieve a list of endpoints
The id of the endpoint
The id of the workspace
The slug of the endpoint
Required string length:
4 - 64The name of the endpoint
Required string length:
4 - 64The state of the endpoint. If is false, the endpoint don't receive more submissions
The state of the email notifications. If is true, the endpoint will send a notification for each submission created
The redirect url of the endpoint. When a user send a submission through a form, will be redirected to this url.
The icon of the endpoint
Available options:
file, file-chart, start, bookmark, heart, flag, bolt, bell, lightbulb, credit-card, stack, cube, database, server, inbox, calendar, mail, checkcircle, book, chat, user-group, console, tools, grid, moon, sun, cloud, cart, gift, music, beaker, video, code, maps, face-smile, face-frown, paint, bug, school, rocket The color the endpoint icon
Available options:
gray, amber, red, lime, teal, cyan, indigo, violet, pink, white Was this page helpful?
curl --request GET \
--url https://api.formizee.com/v1/endpoints \
--header 'Authorization: Bearer <token>'{
"_metadata": {
"page": 1,
"totalPages": 2,
"itemsPerPage": 100
},
"endpoints": [
{
"id": "enp_4VjHrJoEwAFC6itz8oUBW9NW2bia",
"workspaceId": "ws_4VjHrJoEwAFC6itz8oUBW9NW2bia",
"slug": "my-endpoint",
"name": "My Endpoint",
"isEnabled": true,
"emailNotifications": false,
"redirectUrl": "https://example.com/thanks-you",
"targetEmails": [
"[email protected]",
"[email protected]"
],
"icon": "bolt",
"color": "pink"
}
]
}