P
ProFormsDocs

List Clients

Retrieve all clients in your organization. Clients group sites by customer or brand.

clients.view
GET/v1/clients

Query Parameters

searchstring

Search by client name, contact name, or contact email

archivedstring

Show archived clients: true or false (default: false)

pageinteger

Page number (default: 1)

limitinteger

Results per page, 1–100 (default: 25)

Example Request

curl
curl "https://proforms.io/api/v1/clients" \
  -H "Authorization: Bearer pf_your_api_key"

Response

200 OK
{
  "success": true,
  "data": {
    "clients": [
      {
        "id": "c_abc123",
        "name": "Acme Corp",
        "slug": "acme-corp",
        "logo": null,
        "color": "#10B981",
        "contactName": "Jane Smith",
        "contactEmail": "jane@acme.com",
        "contactPhone": "801-555-1234",
        "notes": "Enterprise client — monthly retainer",
        "isArchived": false,
        "archivedAt": null,
        "siteCount": 3,
        "formCount": 12,
        "submissionCount": 847,
        "createdAt": "2026-01-10T10:00:00.000Z",
        "updatedAt": "2026-02-15T14:00:00.000Z"
      }
    ],
    "total": 1,
    "page": 1,
    "limit": 25,
    "totalPages": 1
  }
}
ℹī¸
Clients require the Agency plan. API calls return 403 if your organization is on a lower tier.