Get a record

v1.0.0

Gets a single person, company or other record by its record_id.

Required scopes: record_permission:read, object_configuration:read.

Input

{
  "type": "object",
  "properties": {
    "object": {
      "type": "string",
      "description": "A UUID or slug identifying the object that the record belongs to."
    },
    "record_id": {
      "type": "string",
      "format": "uuid",
      "description": "A UUID identifying the record."
    }
  },
  "required": [
    "object",
    "record_id"
  ],
  "additionalProperties": false
}

Output

{
  "type": "object",
  "description": "Success",
  "required": [
    "data"
  ],
  "properties": {
    "data": {
      "type": "object",
      "required": [
        "created_at",
        "id",
        "values",
        "web_url"
      ],
      "properties": {
        "created_at": {
          "type": "string",
          "description": "When this record was created."
        },
        "id": {
          "type": "object",
          "required": [
            "object_id",
            "record_id",
            "workspace_id"
          ],
          "properties": {
            "object_id": {
              "type": "string",
              "format": "uuid",
              "description": "A UUID identifying the object this record belongs to."
            },
            "record_id": {
              "type": "string",
              "format": "uuid",
              "description": "A UUID identifying this record."
            },
            "workspace_id": {
              "type": "string",
              "format": "uuid",
              "description": "A UUID identifying the workspace this record belongs to."
            }
          }
        },
        "values": {
          "type": "object",
          "description": "A record type with an attribute `api_slug` as the key, and an array of value objects as the values."
        },
        "web_url": {
          "type": "string",
          "format": "uri",
          "description": "A URL that links directly to the record page in the Attio web application."
        }
      }
    }
  }
}