Read one record

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 and to the record. A missing or foreign record answers 404; a record of the workspace you cannot read answers 403.

POST
/v1/records/read

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/read" \  -H "Content-Type: application/json" \  -d '{    "typeId": "caab7c42-4ce7-4bd5-bbab-6017cec730b7",    "recordId": "0470cfd4-dcf3-4d8c-ac28-58c6deeff25f"  }'
{
  "ref": {
    "typeId": "caab7c42-4ce7-4bd5-bbab-6017cec730b7",
    "recordId": "0470cfd4-dcf3-4d8c-ac28-58c6deeff25f"
  },
  "version": 9007199254740991,
  "schemaRevision": -9007199254740991,
  "createdAt": "2019-08-24T14:15:22Z",
  "updatedAt": "2019-08-24T14:15:22Z",
  "fields": [
    {
      "fieldId": "84922011-b03d-4966-bc95-c5b49bc2e342",
      "result": {
        "state": "value",
        "value": {
          "kind": "text",
          "value": "string"
        }
      }
    }
  ],
  "assignedUserIds": [
    "497f6eca-6276-4993-bfeb-53cbbbba6f08"
  ],
  "assignedUsers": [],
  "memberUsers": [],
  "relationships": [],
  "relationshipPaths": [
    {
      "records": [
        {
          "ref": {
            "typeId": "caab7c42-4ce7-4bd5-bbab-6017cec730b7",
            "recordId": "0470cfd4-dcf3-4d8c-ac28-58c6deeff25f"
          },
          "title": {
            "state": "value",
            "value": {
              "kind": "text",
              "value": "string"
            }
          },
          "pictureUrl": "string"
        }
      ],
      "readableCount": 9007199254740991,
      "hasMore": true,
      "pathId": "fdfc0ab2-49fe-4a01-b8e7-363fd2ea9121"
    }
  ],
  "identities": [
    {
      "provider": "google",
      "value": "string",
      "messagingId": "string",
      "displayName": "string",
      "profileUrl": "string",
      "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
      "aliases": [
        "string"
      ],
      "channelClass": "string",
      "createdAt": "2019-08-24T14:15:22Z",
      "updatedAt": "2019-08-24T14:15:22Z"
    }
  ],
  "files": [
    {
      "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
      "name": "string",
      "mimeType": "string",
      "size": 9007199254740991,
      "uploadedAt": "2019-08-24T14:15:22Z",
      "uploadedById": "e4e90afa-33ee-4f3f-ba8f-3fb33b13c87d",
      "pageCount": 9007199254740991
    }
  ]
}
{
  "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