API reference/Clients

List clients

Try it

The businesses you build sites for, by name. Archived clients are left out unless you ask for archived=true.

GET/api/v1/clients

Authentication

An API key as Authorization: Bearer or x-api-key. It needs the clients:read scope — read clients.

clients:readRead onlyMCP tool: list_clients

Parameters

Named placeholders go in the path; the rest in the query string.

archivedstringQuery · optional: true = only archived clients.One of: 0, 1, true, false
limitintegerQuery · optional: How many to return (1–100).1 to 100Default 50
cursorstringQuery · optional: next_cursor from the previous page.1 to 100 characters

Response

200 with JSON on success (schema on the right). Errors use the standard envelope.

curl

curl -X GET 'https://websites.workflowcorp.com/api/v1/clients' \
  -H "Authorization: Bearer $WEBSITEBUDDY_API_KEY"

Example arguments

{}

Response schema

{
  "type": "object",
  "properties": {
    "data": {
      "type": "array",
      "items": {
        "type": "object",
        "properties": {
          "id": {
            "type": "string"
          },
          "name": {
            "type": "string"
          },
          "contact_name": {
            "anyOf": [
              {
                "type": "string"
              },
              {
                "type": "null"
              }
            ]
          },
          "email": {
            "anyOf": [
              {
                "type": "string"
              },
              {
                "type": "null"
              }
            ]
          },
          "phone": {
            "anyOf": [
              {
                "type": "string"
              },
              {
                "type": "null"
              }
            ]
          },
          "address": {
            "anyOf": [
              {
                "type": "string"
              },
              {
                "type": "null"
              }
            ]
          },
          "notes": {
            "anyOf": [
              {
                "type": "string"
              },
              {
                "type": "null"
              }
            ]
          },
          "archived": {
            "type": "boolean"
          },
          "site_ids": {
            "type": "array",
            "items": {
              "type": "string"
            }
          },
          "is_sample": {
            "type": "boolean"
          },
          "created_at": {
            "type": "string"
          }
        },
        "required": [
          "id",
          "name",
          "contact_name",
          "email",
          "phone",
          "address",
          "notes",
          "archived",
          "site_ids",
          "is_sample",
          "created_at"
        ],
        "additionalProperties": false
      }
    },
    "has_more": {
      "type": "boolean"
    },
    "next_cursor": {
      "anyOf": [
        {
          "type": "string"
        },
        {
          "type": "null"
        }
      ]
    }
  },
  "required": [
    "data",
    "has_more",
    "next_cursor"
  ],
  "additionalProperties": false
}