List endpoints

curl --request GET \
  --url https://api.formizee.com/v1/endpoints \
  --header 'Authorization: Bearer <token>'

{
  "_metadata": {
    "totalPages": 2,
    "page": 1,
    "itemsPerPage": 100
  },
  "endpoints": [
    {
      "id": "enp_4VjHrJoEwAFC6itz8oUBW9NW2bia",
      "workspaceId": "ws_4VjHrJoEwAFC6itz8oUBW9NW2bia",
      "slug": "my-endpoint",
      "name": "My Endpoint",
      "targetEmails": [
        "[email protected]",
        "[email protected]"
      ],
      "isEnabled": true,
      "emailNotifications": false,
      "redirectUrl": "https://example.com/thanks-you",
      "icon": "bolt",
      "color": "pink"
    }
  ]
}

GET

endpoints

List endpoints

curl --request GET \
  --url https://api.formizee.com/v1/endpoints \
  --header 'Authorization: Bearer <token>'

{
  "_metadata": {
    "totalPages": 2,
    "page": 1,
    "itemsPerPage": 100
  },
  "endpoints": [
    {
      "id": "enp_4VjHrJoEwAFC6itz8oUBW9NW2bia",
      "workspaceId": "ws_4VjHrJoEwAFC6itz8oUBW9NW2bia",
      "slug": "my-endpoint",
      "name": "My Endpoint",
      "targetEmails": [
        "[email protected]",
        "[email protected]"
      ],
      "isEnabled": true,
      "emailNotifications": false,
      "redirectUrl": "https://example.com/thanks-you",
      "icon": "bolt",
      "color": "pink"
    }
  ]
}

Authorizations

Authorization

string

header

required

Bearer authentication header of the form Bearer <token>, where <token> is your auth token.

Query Parameters

page

number

default:1

Required range: x >= 1

limit

number

default:100

Required range: x >= 1

Response

Retrieve a list of endpoints

_metadata

object

required

Show child attributes

_metadata.totalPages

number

required

Required range: x >= 1

_metadata.page

number

default:1

Required range: x >= 1

_metadata.itemsPerPage

number

default:100

Required range: 1 <= x <= 256

endpoints

object[]

required

Show child attributes

endpoints.id

string

required

The id of the endpoint

Example:

"enp_4VjHrJoEwAFC6itz8oUBW9NW2bia"

endpoints.workspaceId

string

required

The id of the workspace

Example:

"ws_4VjHrJoEwAFC6itz8oUBW9NW2bia"

endpoints.slug

string

required

The slug of the endpoint

Required string length: 4 - 64

Example:

"my-endpoint"

endpoints.name

string

required

The name of the endpoint

Required string length: 4 - 64

Example:

"My Endpoint"

endpoints.targetEmails

string<email>[]

required

Example:

[
  "[email protected]",
  "[email protected]"
]

endpoints.isEnabled

boolean

default:true

The state of the endpoint. If is false, the endpoint don't receive more submissions

Example:

true

endpoints.emailNotifications

boolean

default:true

The state of the email notifications. If is true, the endpoint will send a notification for each submission created

Example:

false

endpoints.redirectUrl

string<uri>

default:https://formizee.com/f/thanks-you

The redirect url of the endpoint. When a user send a submission through a form, will be redirected to this url.

Example:

"https://example.com/thanks-you"

endpoints.icon

enum<string>

default:file

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

Example:

"bolt"

endpoints.color

enum<string>

default:gray

The color the endpoint icon

Available options:

gray,

amber,

red,

lime,

teal,

cyan,

indigo,

violet,

pink,

white

Example:

"pink"

Retrieve a endpoint Create a endpoint

⌘I

API Documentation

Authorizations

Query Parameters

Response