API reference/Clients

Get a client

Try it

One client record and the ids of its sites.

GET/api/v1/clients/{client_id}

Authentication

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

clients:readRead onlyMCP tool: get_client

Parameters

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

client_idstringPath · required: The client's id.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/CLIENT_ID' \
  -H "Authorization: Bearer $WEBSITEBUDDY_API_KEY"

Example arguments

{
  "client_id": "CLIENT_ID"
}

Response schema

{
  "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
}