# Sources

A source is one website or tool that sends submissions to a form, with an endpoint address of its own. Connect, pause, rotate and remove them from your code.

## List sources

`GET https://formpik.com/api/v1/sources`

Newest first. Filter by form with `?form=frm_...`.

## Read one source

`GET https://formpik.com/api/v1/sources/{id}`

*200 OK*

```json
{
  "data": {
    "id": "src_m3n5b7v9c1",
    "form_id": "frm_q8w2e4r6t1",
    "name": "Marketing site",
    "platform": "webflow",
    "domain": "yourcompany.com",
    "status": "live",
    "key": "k4m8q2w6e1r3",
    "endpoint_url": "https://formpik.com/api/in/k4m8q2w6e1r3",
    "last_submission_at": "2026-11-20T09:30:00.000Z",
    "created_at": "2026-11-02T14:15:31.000Z"
  }
}
```

- `status` is `waiting` until the first submission arrives, then `live`, or `paused`.
- `endpoint_url` is where the website posts. See [Send a submission](https://formpik.com/docs/api/submit).
- A published form has a source with `platform` `hosted`, named Share link, that its own page and embeds post to. Formpik makes it when the form is published, it never counts toward the plan, and its form cannot change. Pausing it closes the share link.

## Connect a source

`POST https://formpik.com/api/v1/sources`

Answers `201` with the source and its endpoint address. Needs a key with full or admin access.

**Body**

- `form_id` (string, required): The form its submissions go to.
- `name` (string): Up to 100 characters. "Website" when left out.
- `platform` (string): One of `webflow`, `framer`, `wordpress`, `wix`, `squarespace`, `html`, `javascript`, `zapier`. Decides the setup guide shown in the dashboard. `html` when left out.
- `domain` (string): The website, such as `yourcompany.com`.

*cURL*

```bash
curl -X POST "https://formpik.com/api/v1/sources" \
  -H "Authorization: Bearer $FORMPIK_API_KEY" \
  -H "Content-Type: application/json" \
  -d '{"form_id": "frm_q8w2e4r6t1", "name": "Marketing site", "platform": "webflow", "domain": "yourcompany.com"}'
```

## Change a source

`PATCH https://formpik.com/api/v1/sources/{id}`

Send any of `name`, `platform`, `domain`, `form_id` and `status`. Needs a key with full or admin access.

Set `status` to `paused` to stop taking submissions, which the endpoint then refuses with `403`, and to `active` to take them again.

*cURL*

```bash
curl -X PATCH "https://formpik.com/api/v1/sources/src_m3n5b7v9c1" \
  -H "Authorization: Bearer $FORMPIK_API_KEY" \
  -H "Content-Type: application/json" \
  -d '{"status": "paused"}'
```

## Rotate the endpoint address

`POST https://formpik.com/api/v1/sources/{id}/rotate-key`

Gives the source a new `key` and `endpoint_url`. Needs a key with full or admin access.

> **The old address stops at once**
>
> Anything still posting to the old address gets a 404 from that moment, so update the website right after you rotate.

## Remove a source

`DELETE https://formpik.com/api/v1/sources/{id}`

Its endpoint stops taking submissions. The submissions it brought in stay. Needs a key with full or admin access.

---

Source: https://formpik.com/docs/api/sources
