---
title: "List endpoints"
method: GET
path: "/v1/endpoints"
tags: ["Endpoints"]
---

# List endpoints

`GET /v1/endpoints`

## Query parameters

- `page` number
- `limit` number

## Response `200`

Retrieve a list of endpoints

- object
  - `_metadata` object, required
    - `page` number
    - `totalPages` number, required
    - `itemsPerPage` number
  - `endpoints` object[], required
    - `id` string, required — The id of the endpoint
    - `workspaceId` string, required — The id of the workspace
    - `slug` string, required — The slug of the endpoint
    - `name` string, required — The name of the endpoint
    - `isEnabled` boolean — The state of the endpoint. If is false, the endpoint don't receive more submissions
    - `emailNotifications` boolean — The state of the email notifications. If is true, the endpoint will send a notification for each submission created
    - `redirectUrl` string, uri — The redirect url of the endpoint. When a user send a submission through a form, will be redirected to this url.
    - `targetEmails` string[], required
    - `icon` '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 icon of the endpoint
    - `color` 'gray' | 'amber' | 'red' | 'lime' | 'teal' | 'cyan' | 'indigo' | 'violet' | 'pink' | 'white' — The color the endpoint icon

## Other responses

- `400` — The server cannot or will not process the request due to something that is perceived to be a client error (e.g., malformed request syntax, invalid request message framing, or deceptive request routing).
- `401` — The client must authenticate itself to get the requested response.
- `403` — The client does not have the necessary permissions to access the resource.
- `404` — The server can't find the requested resource.
- `405` — The request could not be completed due to a conflict mainly due to unique constraints.
- `409` — The request could not be completed due to a conflict mainly due to unique constraints.
- `413` — The request body size is too large to be processed by the server.
- `429` — You have made too many requests in a short period of time.
- `500` — The server has encountered a situation it doesn't know how to handle.
- `504` — The server is taking a long time to respond to requests due to load problems.

---

[API](https://skmtc.dev/formizee/apis/formizee-api.md) · [All operations](https://skmtc.dev/formizee/apis/formizee-api/llms.txt) · [OpenAPI document](https://skmtc-service-production.skmtc.workers.dev/v1/apis/formizee/formizee-api/revisions/50633cdf6960/schema)