Skip to content

API reference

Team and access

Invite people, change roles and remove members, make and revoke API keys, and disconnect agent apps. Everything the Members and API keys pages do, for keys with admin access.

List the team

GEThttps://formpik.com/api/v1/members

The owner first, then whoever can change the most, each with their role and its permissions, then the invitations still waiting for an answer. Add ?role= to keep only one role.

cURL
curl -X GET "https://formpik.com/api/v1/members" \
  -H "Authorization: Bearer $FORMPIK_API_KEY"
200 OK
{
  "data": {
    "members": [
      { "id": "5f1c2a7e-0b9d-4e61-a2f3-7c8d9e0a1b2c", "user_id": "usr_k2j4h6g8f0", "email": "ana@northwind.studio", "name": "Ana Silva", "role": "owner", "role_name": "Owner", "permissions": ["forms.manage", "flows.manage", "..."], "owner": true, "joined_at": "2026-10-02T08:12:44.000Z", "last_active_at": "2026-11-20T17:03:12.000Z" },
      { "id": "9a8b7c6d-5e4f-4a3b-9c2d-1e0f9a8b7c6d", "user_id": "usr_p9o8i7u6y5", "email": "sam@northwind.studio", "name": "Sam Lee", "role": "role_k3x9p2m7qa", "role_name": "Support", "permissions": ["submissions.manage"], "owner": false, "joined_at": "2026-10-11T12:40:02.000Z", "last_active_at": null }
    ],
    "invitations": [
      { "id": "1b2c3d4e-5f6a-4b7c-8d9e-0f1a2b3c4d5e", "email": "kai@northwind.studio", "role": "viewer", "role_name": "Viewer", "invited_by": "Ana Silva", "created_at": "2026-11-19T09:00:00.000Z", "expires_at": "2026-11-26T09:00:00.000Z", "expired": false }
    ]
  }
}

Invite someone

POSThttps://formpik.com/api/v1/invitations

Emails a link that works for 7 days and answers 201. Inviting the same address again sends a fresh link instead of a second invitation. Counts toward the plan's team seats, and a key can send at most 10 invitations a day.

Body

emailstringrequired
Their email address. Someone already on the team answers 409 with already-member.
rolestringrequired
admin, editor, viewer or the id of one of your own roles (role_...). See Roles and permissions for what each can do.
cURL
curl -X POST "https://formpik.com/api/v1/invitations" \
  -H "Authorization: Bearer $FORMPIK_API_KEY" \
  -H "Content-Type: application/json" \
  -d '{"email": "kai@northwind.studio", "role": "viewer"}'

An invitation sent with an API key comes from the workspace itself, signed as "The Northwind Studio team", and one sent by an agent app from the person who connected it.

Resend or withdraw an invitation

POSThttps://formpik.com/api/v1/invitations/{id}/resend

Emails a fresh link, valid for another 7 days. The old link stops working.

DELETEhttps://formpik.com/api/v1/invitations/{id}

Withdraws the invitation, so its link stops working.

Change a role, or remove someone

PATCHhttps://formpik.com/api/v1/members/{id}

Send { "role": "editor" }: admin, editor, viewer or one of your own roles (role_...). Answers with the member. The owner keeps their role.

DELETEhttps://formpik.com/api/v1/members/{id}

Removes the person from the workspace. They lose access at once. The owner cannot be removed.

  • Use the member id from List the team, not the user_id.
  • An agent app acting for a person can never change its own person's role or remove them, and never gives anyone more than that person's role has. See What nobody can do.

API keys

GEThttps://formpik.com/api/v1/api-keys

Every key with its name, preview, access and when it was last used. The keys themselves are never shown again.

POSThttps://formpik.com/api/v1/api-keys

Makes a key from { "name": "Nightly export", "access": "read" } (read, full or admin; read when left out) and answers 201. Counts toward the plan's API keys.

201 Created
{
  "data": {
    "id": "key_r5t7y9u1i3",
    "name": "Nightly export",
    "preview": "fp_live_...x7Qe",
    "access": "read",
    "created_at": "2026-11-21T10:02:11.000Z",
    "last_used_at": null
  },
  "secret": "fp_live_3hJ8kL2mN6pQ9rS1tU4vW7xY0zA5bC8x7Qe"
}
DELETEhttps://formpik.com/api/v1/api-keys/{id}

Revokes the key: anything using it gets 401 from then on. Revoking the key that makes the call works too, and the answer says so in revoked_itself.

Connected apps

GEThttps://formpik.com/api/v1/connected-apps

The agent apps signed in with a link, everyone's, with connected_by, access and when each was last used.

DELETEhttps://formpik.com/api/v1/connected-apps/{id}

Ends the app's sign-in at once. It has to be connected again to come back.