2X · Schema

ClientListResponse

Response model for list of clients.

CompanyMarketingMarketing as a ServiceB2BMarTechMarketing OperationsConsultingArtificial IntelligenceGo-To-MarketRevenue OperationsCommercial IntelligenceCustomer SuccessAI AgentsDemand Generation

Properties

Name Type Description
clients array
total integer
customerId string
View JSON Schema on GitHub

JSON Schema

2x-client-list-response-schema.json Raw ↑
{
  "$schema": "https://json-schema.org/draft/2020-12/schema",
  "$id": "https://artifacts.apis.io/2x/json-schema/2x-client-list-response-schema.json",
  "title": "ClientListResponse",
  "description": "Response model for list of clients.",
  "x-generated": "2026-11-04",
  "x-method": "derived",
  "x-generator": "derive-json-schema.py",
  "x-source": "openapi/2x-clients-api-openapi.yml#/components/schemas/ClientListResponse",
  "properties": {
    "clients": {
      "items": {
        "$ref": "#/$defs/ClientResponse"
      },
      "type": "array",
      "title": "Clients"
    },
    "total": {
      "type": "integer",
      "title": "Total"
    },
    "customerId": {
      "type": "string",
      "title": "Customerid"
    }
  },
  "type": "object",
  "required": [
    "clients",
    "total",
    "customerId"
  ],
  "$defs": {
    "ClientMetadata": {
      "properties": {
        "accountOwner": {
          "anyOf": [
            {
              "type": "string"
            },
            {
              "type": "null"
            }
          ],
          "title": "Accountowner"
        },
        "annualRevenue": {
          "anyOf": [
            {
              "type": "string"
            },
            {
              "type": "null"
            }
          ],
          "title": "Annualrevenue"
        },
        "industry": {
          "anyOf": [
            {
              "type": "string"
            },
            {
              "type": "null"
            }
          ],
          "title": "Industry"
        },
        "location": {
          "anyOf": [
            {
              "type": "string"
            },
            {
              "type": "null"
            }
          ],
          "title": "Location"
        },
        "active": {
          "anyOf": [
            {
              "type": "boolean"
            },
            {
              "type": "null"
            }
          ],
          "title": "Active"
        },
        "accountStatus": {
          "anyOf": [
            {
              "type": "string"
            },
            {
              "type": "null"
            }
          ],
          "title": "Accountstatus"
        },
        "domain": {
          "anyOf": [
            {
              "type": "string"
            },
            {
              "type": "null"
            }
          ],
          "title": "Domain"
        },
        "clientType": {
          "anyOf": [
            {
              "type": "string"
            },
            {
              "type": "null"
            }
          ],
          "title": "Clienttype"
        },
        "revenueTTM": {
          "anyOf": [
            {
              "type": "number"
            },
            {
              "type": "null"
            }
          ],
          "title": "Revenuettm"
        },
        "revenueF12M": {
          "anyOf": [
            {
              "type": "number"
            },
            {
              "type": "null"
            }
          ],
          "title": "Revenuef12M"
        }
      },
      "type": "object",
      "title": "ClientMetadata",
      "description": "Client metadata."
    },
    "ClientResponse": {
      "properties": {
        "id": {
          "type": "string",
          "title": "Id"
        },
        "customerId": {
          "type": "string",
          "title": "Customerid"
        },
        "name": {
          "type": "string",
          "title": "Name"
        },
        "score": {
          "type": "integer",
          "title": "Score"
        },
        "scoreSource": {
          "anyOf": [
            {
              "type": "string"
            },
            {
              "type": "null"
            }
          ],
          "title": "Scoresource",
          "description": "Score data source: chr1 or chr2"
        },
        "scoreChanges": {
          "anyOf": [
            {
              "$ref": "#/$defs/ScoreChanges"
            },
            {
              "type": "null"
            }
          ],
          "description": "Score changes over time"
        },
        "lastContactDate": {
          "anyOf": [
            {
              "type": "string",
              "format": "date-time"
            },
            {
              "type": "null"
            }
          ],
          "title": "Lastcontactdate"
        },
        "lastUpdatedAt": {
          "anyOf": [
            {
              "type": "string",
              "format": "date-time"
            },
            {
              "type": "null"
            }
          ],
          "title": "Lastupdatedat"
        },
        "hasInsufficientData": {
          "anyOf": [
            {
              "type": "boolean"
            },
            {
              "type": "null"
            }
          ],
          "title": "Hasinsufficientdata"
        },
        "metadata": {
          "anyOf": [
            {
              "$ref": "#/$defs/ClientMetadata"
            },
            {
              "type": "null"
            }
          ]
        },
        "extraColumns": {
          "anyOf": [
            {
              "additionalProperties": {
                "type": "string"
              },
              "type": "object"
            },
            {
              "type": "null"
            }
          ],
          "title": "Extracolumns",
          "description": "Custom column values"
        },
        "historicalData": {
          "anyOf": [
            {
              "items": {
                "type": "integer"
              },
              "type": "array"
            },
            {
              "type": "null"
            }
          ],
          "title": "Historicaldata"
        },
        "archived": {
          "anyOf": [
            {
              "type": "boolean"
            },
            {
              "type": "null"
            }
          ],
          "title": "Archived"
        }
      },
      "type": "object",
      "required": [
        "id",
        "customerId",
        "name",
        "score"
      ],
      "title": "ClientResponse",
      "description": "Response model for client data."
    },
    "ScoreChange": {
      "properties": {
        "change": {
          "type": "number",
          "title": "Change",
          "description": "Absolute change in score"
        },
        "percentage": {
          "anyOf": [
            {
              "type": "number"
            },
            {
              "type": "null"
            }
          ],
          "title": "Percentage",
          "description": "Percentage change"
        },
        "previousScore": {
          "type": "number",
          "title": "Previousscore",
          "description": "Score at start of period"
        }
      },
      "type": "object",
      "required": [
        "change",
        "previousScore"
      ],
      "title": "ScoreChange",
      "description": "Score change over a time period."
    },
    "ScoreChanges": {
      "properties": {
        "7day": {
          "anyOf": [
            {
              "$ref": "#/$defs/ScoreChange"
            },
            {
              "type": "null"
            }
          ],
          "description": "7-day change"
        },
        "30day": {
          "anyOf": [
            {
              "$ref": "#/$defs/ScoreChange"
            },
            {
              "type": "null"
            }
          ],
          "description": "30-day change"
        }
      },
      "type": "object",
      "title": "ScoreChanges",
      "description": "Score changes over different time periods."
    }
  }
}

Work with this as data

Every JSON Schema here is available over the APIs.io API and to AI agents over MCP.

MCP server

One button, every client — Claude, Cursor, VS Code and the rest.

https://apis.io/mcp

Tools for schemas

4 MCP tools reach this
  • find_json_schemasBrowse and filter every JSON Schema in the catalog.
  • apis_io_searchSTART HERE — APIs, providers and tags for one query, each with its total.
  • resolveTurn a domain, URL or GitHub org into the provider it belongs to.
  • find_cohortsEvery scored population of providers in the catalog.
All 92 tools →

Call it yourself

curl for this page
This JSON Schema
curl "https://apis.io/api/v1/json-schemas/2x-client-list-response"
All schemas
curl "https://apis.io/api/v1/json-schemas?limit=25"

Calls without X-API-Key need no key. Calls with it need a paid plan — get a key.

Get an API key

Free tier, no form to fill in. Signing in shares your email address with us — we store it to create your key and to recognise you if you sign in with another provider. See our Privacy Policy and Terms.

A second provider on the same verified email joins the account you already have.