Search accessible record types

Configurable CRM record contract. Record references contain both typeId and recordId. Workspace scope comes from authentication. Decimal values are strings. Reads change nothing and return only what the caller may read.

Requires: read access to the list; only readable records are returned.

POST
/v1/records/search

Authorization

apiKeyAuth
x-api-key<token>

API key authentication. Create an API key in your user profile and include it in the x-api-key header.

In: header

Request Body

application/json

TypeScript Definitions

Use the request body type in TypeScript.

Response Body

application/json

application/json

application/json

application/json

application/json

application/json

application/json

application/json

curl -X POST "https://customermates.com/api/v1/records/search" \  -H "Content-Type: application/json" \  -d '{    "searchTerm": "string"  }'
{
  "results": [
    {
      "ref": {
        "typeId": "caab7c42-4ce7-4bd5-bbab-6017cec730b7",
        "recordId": "0470cfd4-dcf3-4d8c-ac28-58c6deeff25f"
      },
      "title": {
        "state": "value",
        "value": {
          "kind": "text",
          "value": "string"
        }
      },
      "typeLabel": "string",
      "typePluralLabel": "string",
      "icon": "string",
      "pictureUrl": "string",
      "canEdit": true
    }
  ],
  "schemaRevision": 9007199254740991,
  "nextCursor": {
    "revision": 9007199254740991,
    "createdAt": "2019-08-24T14:15:22Z",
    "ref": {
      "typeId": "caab7c42-4ce7-4bd5-bbab-6017cec730b7",
      "recordId": "0470cfd4-dcf3-4d8c-ac28-58c6deeff25f"
    },
    "rank": 4
  }
}
{
  "error": {
    "kind": "validation",
    "issues": [
      {
        "code": "string",
        "path": [
          "string"
        ],
        "message": "string",
        "customCode": "recordNotFound",
        "entitlement": "string"
      }
    ],
    "retryable": true
  }
}
{
  "error": {
    "kind": "validation",
    "issues": [
      {
        "code": "string",
        "path": [
          "string"
        ],
        "message": "string",
        "customCode": "recordNotFound",
        "entitlement": "string"
      }
    ],
    "retryable": true
  }
}
{
  "error": {
    "kind": "validation",
    "issues": [
      {
        "code": "string",
        "path": [
          "string"
        ],
        "message": "string",
        "customCode": "recordNotFound",
        "entitlement": "string"
      }
    ],
    "retryable": true
  }
}
{
  "error": {
    "kind": "validation",
    "issues": [
      {
        "code": "string",
        "path": [
          "string"
        ],
        "message": "string",
        "customCode": "recordNotFound",
        "entitlement": "string"
      }
    ],
    "retryable": true
  }
}
{
  "error": {
    "kind": "validation",
    "issues": [
      {
        "code": "string",
        "path": [
          "string"
        ],
        "message": "string",
        "customCode": "recordNotFound",
        "entitlement": "string"
      }
    ],
    "retryable": true
  }
}
{
  "error": {
    "kind": "validation",
    "issues": [
      {
        "code": "string",
        "path": [
          "string"
        ],
        "message": "string",
        "customCode": "recordNotFound",
        "entitlement": "string"
      }
    ],
    "retryable": true
  }
}
{
  "error": {
    "kind": "validation",
    "issues": [
      {
        "code": "string",
        "path": [
          "string"
        ],
        "message": "string",
        "customCode": "recordNotFound",
        "entitlement": "string"
      }
    ],
    "retryable": true
  }
}
Empty