---
updatedAt: 2025-03-26T16:58:25.000Z
agentTools:
  projectIndex: https://docs.livedatatech.com/llms.txt
---

# Preview finding a specific person

Find a specific person in Live Data that matches the given criteria. 

For people finding, the following fields are supported: `name`, `title`, `linkedin`, `company.name`, `company.linkedin`, `email_address`, `company.ticker`, `company.domain`, `education.school`. As many fields as are available should be sent in - the service implements a backend waterfall to find the best match(es).

The `matches` array has a max size of 100. For each item in the match array, the response array at the same index will contain all people that match the provided fields with a `score` of how well the person matches the input fields.

1 hit per match is provided. 

For queries of large groups of people, see `/search`

# OpenAPI definition

```json
{
  "openapi": "3.0.0",
  "info": {
    "version": "1.0",
    "title": "Live Data People API",
    "description": "This API provides information about people as observed by Live Data",
    "termsOfService": "https://www.livedatatechnologies.com/terms-of-service",
    "contact": {
      "name": "Live Data Technologies",
      "url": "https://www.livedatatechnologies.com",
      "email": "support@livedatatechnologies.com"
    },
    "license": {
      "url": "https://creativecommons.org/licenses/by-nd/4.0",
      "name": "Attribution-NoDerivs"
    }
  },
  "servers": [
    {
      "url": "https://gotlivedata.io/api/people/v1",
      "description": "Production"
    }
  ],
  "security": [
    {
      "AccessToken": []
    }
  ],
  "tags": [
    {
      "name": "Search"
    }
  ],
  "paths": {
    "/{org_id}/find/preview": {
      "parameters": [
        {
          "schema": {
            "type": "string"
          },
          "name": "org_id",
          "in": "path",
          "required": true,
          "description": "Your Org ID"
        }
      ],
      "post": {
        "summary": "Preview finding a specific person",
        "operationId": "find-preview",
        "responses": {
          "200": {
            "description": "OK",
            "content": {
              "application/json": {
                "schema": {
                  "type": "object",
                  "properties": {
                    "matches": {
                      "type": "array",
                      "description": "An array of responses. Each position in the array corresponds to the position in the input array.",
                      "items": {
                        "type": "object",
                        "properties": {
                          "people": {
                            "type": "array",
                            "description": "The people that matched the provided filters. Maximum of 5 returned in this endpoint (use `/search` for larger queries).",
                            "items": {
                              "allOf": [
                                {
                                  "$ref": "#/components/schemas/SamplePerson"
                                },
                                {
                                  "type": "object",
                                  "properties": {
                                    "score": {
                                      "type": "number",
                                      "description": "A score of how well each person matched the input criteria."
                                    }
                                  }
                                }
                              ]
                            }
                          },
                          "found": {
                            "type": "boolean",
                            "description": "Indicates whether there was at least one hit given the provided inputs."
                          }
                        }
                      }
                    }
                  }
                },
                "examples": {
                  "Example 1": {
                    "value": {
                      "matches": [
                        {
                          "people": [
                            {
                              "created_at": "string",
                              "info_change_detected_at": "string",
                              "title_change_detected_at": "string",
                              "company_change_detected_at": "string",
                              "position": {
                                "title": "string",
                                "level": "C-Team",
                                "function": "Banking and Wealth Management",
                                "started_at": "string",
                                "ended_at": "string",
                                "location": "string",
                                "company": {
                                  "id": "string",
                                  "name": "string",
                                  "linkedin": "string",
                                  "domain": "string"
                                },
                                "is_first_at_company": true,
                                "is_last_at_company": true
                              },
                              "jobs": [
                                {
                                  "title": "string",
                                  "level": "C-Team",
                                  "function": "Banking and Wealth Management",
                                  "started_at": "string",
                                  "ended_at": "string",
                                  "location": "string",
                                  "company": {
                                    "id": "string",
                                    "name": "string",
                                    "linkedin": "string",
                                    "domain": "string"
                                  },
                                  "is_first_at_company": true,
                                  "is_last_at_company": true
                                }
                              ],
                              "education": [
                                {
                                  "school": "string"
                                }
                              ],
                              "first_name": "string",
                              "connections": 0,
                              "employment_status": "employed",
                              "score": 0
                            }
                          ],
                          "found": true
                        }
                      ]
                    }
                  }
                }
              }
            }
          }
        },
        "tags": [
          "Search"
        ],
        "description": "Find a specific person in Live Data that matches the given criteria. \r\n\r\nFor people finding, the following fields are supported: `name`, `title`, `linkedin`, `company.name`, `company.linkedin`, `email_address`, `company.ticker`, `company.domain`, `education.school`. As many fields as are available should be sent in - the service implements a backend waterfall to find the best match(es).\r\n\r\nThe `matches` array has a max size of 100. For each item in the match array, the response array at the same index will contain all people that match the provided fields with a `score` of how well the person matches the input fields.\r\n\r\n1 hit per match is provided. \r\n\r\nFor queries of large groups of people, see `/search`",
        "requestBody": {
          "content": {
            "application/json": {
              "schema": {
                "type": "object",
                "properties": {
                  "matches": {
                    "type": "array",
                    "items": {
                      "type": "object",
                      "properties": {
                        "fields": {
                          "type": "array",
                          "items": {
                            "type": "object",
                            "properties": {
                              "field_name": {
                                "type": "string"
                              },
                              "search_term": {
                                "type": "string"
                              }
                            }
                          }
                        }
                      }
                    }
                  }
                }
              },
              "examples": {
                "Example 1": {
                  "value": {
                    "matches": [
                      {
                        "fields": [
                          {
                            "field_name": "email_address",
                            "search_term": "joe@google.com"
                          }
                        ]
                      },
                      {
                        "fields": [
                          {
                            "field_name": "email_address",
                            "search_term": "joe@amazon.com"
                          }
                        ]
                      }
                    ]
                  }
                }
              }
            }
          },
          "description": ""
        },
        "x-stoplight": {
          "id": "l5illtsftaw28"
        }
      }
    }
  },
  "components": {
    "securitySchemes": {
      "AccessToken": {
        "type": "http",
        "scheme": "bearer"
      }
    },
    "schemas": {
      "SamplePerson": {
        "title": "SamplePerson",
        "x-stoplight": {
          "id": "a4arz18yeuv0h"
        },
        "type": "object",
        "description": "Represents a sample of the Person object, used for previewing data.",
        "properties": {
          "id": {
            "type": "string",
            "description": "The unique Live Data ID for this person"
          },
          "created_at": {
            "type": "string",
            "description": "Date the person was added to Live Data"
          },
          "info_change_detected_at": {
            "type": "string",
            "description": "Most recent date that any field changed."
          },
          "title_change_detected_at": {
            "type": "string",
            "description": "Most recent date that Live Data detected a title change."
          },
          "company_change_detected_at": {
            "type": "string",
            "description": "Most recent date that Live Data detected a company change."
          },
          "position": {
            "$ref": "#/components/schemas/SampleJob"
          },
          "jobs": {
            "type": "array",
            "items": {
              "$ref": "#/components/schemas/SampleJob"
            }
          },
          "education": {
            "type": "array",
            "description": "Array of the education history for this person",
            "items": {
              "type": "object",
              "properties": {
                "school": {
                  "type": "string",
                  "description": "Name of the school"
                }
              }
            }
          },
          "first_name": {
            "type": "string",
            "description": "First name, if known"
          },
          "connections": {
            "type": "integer",
            "description": "Number of connections on LinkedIn"
          },
          "employment_status": {
            "enum": [
              "employed",
              "unemployed",
              "retired"
            ]
          }
        }
      },
      "SampleJob": {
        "title": "SampleJob",
        "x-stoplight": {
          "id": "3c70z9b5fyhl2"
        },
        "type": "object",
        "description": "Represents a job, which is a combination of Company+Title",
        "properties": {
          "title": {
            "type": "string",
            "description": "Title of the person at this job"
          },
          "level": {
            "description": "Level derived from title using internal ML process",
            "enum": [
              "C-Team",
              "VP",
              "Director",
              "Manager",
              "Staff",
              "Senior Staff",
              "Intern",
              "Consultant"
            ]
          },
          "function": {
            "description": "Function derived from title using internal ML process",
            "enum": [
              "Banking and Wealth Management",
              "Business Management",
              "Consulting",
              "Education",
              "Engineering",
              "Finance and Administration",
              "Healthcare",
              "Human Resources",
              "Information Technology",
              "Legal",
              "Marketing and Product",
              "Operations",
              "Program and Project Management",
              "Publishing, Editorial and Reporting",
              "Quality",
              "Real Estate",
              "Risk, Safety, Compliance",
              "Sales and Support"
            ]
          },
          "started_at": {
            "type": "string",
            "description": "Date the person started this job. Will always be the 1st day of a month at 00:00"
          },
          "ended_at": {
            "type": "string",
            "description": "Date this job ended. Will always be the 1st day of a month at 00:00"
          },
          "location": {
            "type": "string",
            "description": "Location of this job"
          },
          "company": {
            "$ref": "#/components/schemas/SampleCompany"
          },
          "is_first_at_company": {
            "type": "boolean",
            "description": "Boolean value to indicate whether this is the person’s first job at this company"
          },
          "is_last_at_company": {
            "type": "boolean",
            "description": "Boolean value to indicate whether this is the person’s last job at this company. Note this will be `true` for active jobs."
          }
        }
      },
      "SampleCompany": {
        "title": "SampleCompany",
        "x-stoplight": {
          "id": "cfaqom1koly07"
        },
        "type": "object",
        "description": "Dict of company-specific information related to the job",
        "properties": {
          "id": {
            "type": "string",
            "description": "Unique Live Data ID for this company"
          },
          "name": {
            "type": "string",
            "description": "Name of the company"
          },
          "linkedin": {
            "type": "string",
            "description": "LinkedIn slug for the company"
          },
          "domain": {
            "type": "string",
            "description": "Primary domain for the company"
          }
        }
      }
    }
  }
}
```