Properties
| Name | Type | Description |
|---|---|---|
| typeId | string | |
| locale | string | |
| includeIdentities | boolean | Include registered identifiers for returned records of a list with a contact details (channels) field. |
| search | string | |
| filters | array | |
| relatedFilters | array | |
| relationships | array |
JSON Schema
{
"$schema": "https://json-schema.org/draft/2020-12/schema",
"$id": "https://artifacts.apis.io/customermates-com/json-schema/customermates-com-record-source-schema.json",
"title": "RecordSource",
"x-generated": "2026-10-28",
"x-method": "derived",
"x-generator": "derive-json-schema.py",
"x-source": "openapi/customermates-openapi.json#/components/schemas/RecordSource",
"type": "object",
"properties": {
"typeId": {
"type": "string",
"format": "uuid",
"pattern": "^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$"
},
"locale": {
"type": "string",
"enum": [
"en",
"de",
"fr",
"it",
"es"
]
},
"includeIdentities": {
"description": "Include registered identifiers for returned records of a list with a contact details (channels) field.",
"type": "boolean"
},
"search": {
"type": "string",
"maxLength": 500
},
"filters": {
"default": [],
"maxItems": 50,
"type": "array",
"items": {
"type": "object",
"properties": {
"fieldId": {
"anyOf": [
{
"type": "string",
"format": "uuid",
"pattern": "^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$"
},
{
"type": "string",
"enum": [
"system:createdAt",
"system:updatedAt",
"system:assignedTo"
]
}
]
},
"operator": {
"type": "string",
"enum": [
"eq",
"ne",
"contains",
"startsWith",
"gt",
"gte",
"lt",
"lte",
"empty",
"notEmpty",
"in",
"notIn",
"all",
"between",
"overlaps",
"inLastDays",
"notInLastDays"
],
"description": "For multiple choice fields in, all and notIn take option values and match records holding any, all or none of them. between uses two inclusive date endpoints in values; overlaps takes the same endpoints and also matches a date range that only partly falls between them; a range without an end counts as its start day. inLastDays and notInLastDays use a positive whole day count in value as a decimal without currency. Range contains tests a point; gt/gte test its start, lt/lte its end. Relative windows begin at UTC midnight that many days before the query clock: inLastDays includes later dates, notInLastDays matches only earlier ones."
},
"value": {
"anyOf": [
{
"type": "object",
"properties": {
"kind": {
"type": "string",
"enum": [
"text",
"textList",
"decimal",
"boolean",
"date",
"dateTime",
"range",
"select",
"selectList",
"member",
"richText",
"file",
"address"
]
},
"value": {
"anyOf": [
{
"type": "string",
"maxLength": 100000,
"pattern": "^[^\\u0000]*$"
},
{
"type": "boolean"
},
{
"minItems": 1,
"maxItems": 100,
"type": "array",
"items": {
"type": "string",
"maxLength": 100000,
"pattern": "^[^\\u0000]*$"
}
},
{
"$ref": "#/$defs/RecordAddressPartsInput"
}
]
},
"currency": {
"anyOf": [
{
"type": "string",
"pattern": "^[A-Z]{3}$"
},
{
"type": "null"
}
]
},
"start": {
"anyOf": [
{
"type": "string",
"pattern": "^[^\\u0000]*$"
},
{
"type": "null"
}
]
},
"end": {
"anyOf": [
{
"type": "string",
"pattern": "^[^\\u0000]*$"
},
{
"type": "null"
}
]
},
"documentJson": {
"type": "string",
"maxLength": 1000000,
"pattern": "^[^\\u0000]*$"
}
},
"required": [
"kind"
],
"additionalProperties": false,
"description": "Typed CRM value; only the fields for the selected kind are allowed. A decimal always sends currency, null when it has none. For richText writes send documentJson as a ProseMirror document JSON string, not the Markdown returned on read. A file value lists uploaded file ids in order; the server formats an address value from its parts."
},
{
"type": "null"
}
]
},
"values": {
"maxItems": 100,
"type": "array",
"items": {
"type": "object",
"properties": {
"kind": {
"type": "string",
"enum": [
"text",
"textList",
"decimal",
"boolean",
"date",
"dateTime",
"range",
"select",
"selectList",
"member",
"richText",
"file",
"address"
]
},
"value": {
"anyOf": [
{
"type": "string",
"maxLength": 100000,
"pattern": "^[^\\u0000]*$"
},
{
"type": "boolean"
},
{
"minItems": 1,
"maxItems": 100,
"type": "array",
"items": {
"type": "string",
"maxLength": 100000,
"pattern": "^[^\\u0000]*$"
}
},
{
"$ref": "#/$defs/RecordAddressPartsInput"
}
]
},
"currency": {
"anyOf": [
{
"type": "string",
"pattern": "^[A-Z]{3}$"
},
{
"type": "null"
}
]
},
"start": {
"anyOf": [
{
"type": "string",
"pattern": "^[^\\u0000]*$"
},
{
"type": "null"
}
]
},
"end": {
"anyOf": [
{
"type": "string",
"pattern": "^[^\\u0000]*$"
},
{
"type": "null"
}
]
},
"documentJson": {
"type": "string",
"maxLength": 1000000,
"pattern": "^[^\\u0000]*$"
}
},
"required": [
"kind"
],
"additionalProperties": false,
"description": "Typed CRM value; only the fields for the selected kind are allowed. A decimal always sends currency, null when it has none. For richText writes send documentJson as a ProseMirror document JSON string, not the Markdown returned on read. A file value lists uploaded file ids in order; the server formats an address value from its parts."
}
}
},
"required": [
"fieldId",
"operator",
"value"
],
"additionalProperties": false
}
},
"relatedFilters": {
"maxItems": 16,
"type": "array",
"items": {
"type": "object",
"properties": {
"path": {
"minItems": 1,
"maxItems": 6,
"type": "array",
"items": {
"type": "object",
"properties": {
"relationId": {
"type": "string",
"format": "uuid",
"pattern": "^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$"
},
"direction": {
"type": "string",
"enum": [
"outgoing",
"incoming"
]
}
},
"required": [
"relationId",
"direction"
],
"additionalProperties": false
}
},
"operator": {
"type": "string",
"enum": [
"any",
"none"
]
},
"filters": {
"maxItems": 50,
"type": "array",
"items": {
"type": "object",
"properties": {
"fieldId": {
"anyOf": [
{
"type": "string",
"format": "uuid",
"pattern": "^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$"
},
{
"type": "string",
"enum": [
"system:createdAt",
"system:updatedAt",
"system:assignedTo"
]
}
]
},
"operator": {
"type": "string",
"enum": [
"eq",
"ne",
"contains",
"startsWith",
"gt",
"gte",
"lt",
"lte",
"empty",
"notEmpty",
"in",
"notIn",
"all",
"between",
"overlaps",
"inLastDays",
"notInLastDays"
],
"description": "For multiple choice fields in, all and notIn take option values and match records holding any, all or none of them. between uses two inclusive date endpoints in values; overlaps takes the same endpoints and also matches a date range that only partly falls between them; a range without an end counts as its start day. inLastDays and notInLastDays use a positive whole day count in value as a decimal without currency. Range contains tests a point; gt/gte test its start, lt/lte its end. Relative windows begin at UTC midnight that many days before the query clock: inLastDays includes later dates, notInLastDays matches only earlier ones."
},
"value": {
"anyOf": [
{
"type": "object",
"properties": {
"kind": {
"type": "string",
"enum": [
"text",
"textList",
"decimal",
"boolean",
"date",
"dateTime",
"range",
"select",
"selectList",
"member",
"richText",
"file",
"address"
]
},
"value": {
"anyOf": [
{
"type": "string",
"maxLength": 100000,
"pattern": "^[^\\u0000]*$"
},
{
"type": "boolean"
},
{
"minItems": 1,
"maxItems": 100,
"type": "array",
"items": {
"type": "string",
"maxLength": 100000,
"pattern": "^[^\\u0000]*$"
}
},
{
"$ref": "#/$defs/RecordAddressPartsInput"
}
]
},
"currency": {
"anyOf": [
{
"type": "string",
"pattern": "^[A-Z]{3}$"
},
{
"type": "null"
}
]
},
"start": {
"anyOf": [
{
"type": "string",
"pattern": "^[^\\u0000]*$"
},
{
"type": "null"
}
]
},
"end": {
"anyOf": [
{
"type": "string",
"pattern": "^[^\\u0000]*$"
},
{
"type": "null"
}
]
},
"documentJson": {
"type": "string",
"maxLength": 1000000,
"pattern": "^[^\\u0000]*$"
}
},
"required": [
"kind"
],
"additionalProperties": false,
"description": "Typed CRM value; only the fields for the selected kind are allowed. A decimal always sends currency, null when it has none. For richText writes send documentJson as a ProseMirror document JSON string, not the Markdown returned on read. A file value lists uploaded file ids in order; the server formats an address value from its parts."
},
{
"type": "null"
}
]
},
"values": {
"maxItems": 100,
"type": "array",
"items": {
"type": "object",
"properties": {
"kind": {
"type": "string",
"enum": [
"text",
"textList",
"decimal",
"boolean",
"date",
"dateTime",
"range",
"select",
"selectList",
"member",
"richText",
"file",
"address"
]
},
"value": {
"anyOf": [
{
"type": "string",
"maxLength": 100000,
"pattern": "^[^\\u0000]*$"
},
{
"type": "boolean"
},
{
"minItems": 1,
"maxItems": 100,
"type": "array",
"items": {
"type": "string",
"maxLength": 100000,
"pattern": "^[^\\u0000]*$"
}
},
{
"$ref": "#/$defs/RecordAddressPartsInput"
}
]
},
"currency": {
"anyOf": [
{
"type": "string",
"pattern": "^[A-Z]{3}$"
},
{
"type": "null"
}
]
},
"start": {
"anyOf": [
{
"type": "string",
"pattern": "^[^\\u0000]*$"
},
{
"type": "null"
}
]
},
"end": {
"anyOf": [
{
"type": "string",
"pattern": "^[^\\u0000]*$"
},
{
"type": "null"
}
]
},
"documentJson": {
"type": "string",
"maxLength": 1000000,
"pattern": "^[^\\u0000]*$"
}
},
"required": [
"kind"
],
"additionalProperties": false,
"description": "Typed CRM value; only the fields for the selected kind are allowed. A decimal always sends currency, null when it has none. For richText writes send documentJson as a ProseMirror document JSON string, not the Markdown returned on read. A file value lists uploaded file ids in order; the server formats an address value from its parts."
}
}
},
"required": [
"fieldId",
"operator",
"value"
],
"additionalProperties": false
}
},
"relationships": {
"default": [],
"maxItems": 50,
"type": "array",
"items": {
"type": "object",
"properties": {
"relationId": {
"type": "string",
"format": "uuid",
"pattern": "^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$"
},
"direction": {
"type": "string",
"enum": [
"outgoing",
"incoming"
]
},
"operator": {
"type": "string",
"enum": [
"any",
"none"
]
},
"recordIds": {
"anyOf": [
{
"maxItems": 100,
"type": "array",
"items": {
"type": "string",
"format": "uuid",
"pattern": "^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$"
}
},
{
"type": "null"
}
]
}
},
"required": [
"relationId",
"direction",
"operator",
"recordIds"
],
"additionalProperties": false
}
},
"search": {
"type": "string",
"maxLength": 500
},
"recordIds": {
"description": "Match these terminal record identities after following the path; all steps require record access.",
"maxItems": 100,
"type": "array",
"items": {
"type": "string",
"format": "uuid",
"pattern": "^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$"
}
}
},
"required": [
"path",
"operator",
"filters"
],
"additionalProperties": false
}
},
"relationships": {
"default": [],
"maxItems": 50,
"type": "array",
"items": {
"type": "object",
"properties": {
"relationId": {
"type": "string",
"format": "uuid",
"pattern": "^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$"
},
"direction": {
"type": "string",
"enum": [
"outgoing",
"incoming"
]
},
"operator": {
"type": "string",
"enum": [
"any",
"none"
]
},
"recordIds": {
"anyOf": [
{
"maxItems": 100,
"type": "array",
"items": {
"type": "string",
"format": "uuid",
"pattern": "^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$"
}
},
{
"type": "null"
}
]
}
},
"required": [
"relationId",
"direction",
"operator",
"recordIds"
],
"additionalProperties": false
}
}
},
"required": [
"typeId"
],
"additionalProperties": false,
"$defs": {
"RecordAddressPartsInput": {
"type": "object",
"properties": {
"street": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
]
},
"line2": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
]
},
"postalCode": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
]
},
"city": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
]
},
"region": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
]
},
"countryCode": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
]
}
},
"additionalProperties": {}
}
}
}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.
Call it yourself
curl for this page
This JSON Schema
curl "https://apis.io/api/v1/json-schemas/customermates-com-record-source"
All schemas
curl "https://apis.io/api/v1/json-schemas?limit=25"Discovery needs no key. Ratings and market analysis are Pro.
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.