get
/Search
People by name, birth place or birth date; records by title, file name, type, event place or date, or a matched person; places on records. Up to 5 people, 5 records and 3 places.
| Name | In | Required | Description |
|---|---|---|---|
| workspace_id | path | yes | The workspace (project) id. |
| q | query | no | 1 to 200 characters. Names match ignoring case, accents and punctuation. |
Responses
- 200 Results. (SearchResults)
- 401 Missing, malformed, unknown or revoked API key. (ErrorResponse)
- 403 The account has no paid plan. (ErrorResponse)
- 404 The workspace does not exist or is not visible to this key's owner. (ErrorResponse)
- 422 q is missing or longer than 200 characters. (ErrorResponse)
- 429 Rate limit exceeded. Wait the number of seconds in Retry-After. (ErrorResponse)
- 500 Unexpected error. Retry later and quote request_id if it persists. (ErrorResponse)
200 response schema
{
"type": "object",
"properties": {
"people": {
"type": "array",
"items": {
"type": "object",
"properties": {
"id": {
"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)$"
},
"display_name": {
"type": "string"
},
"given_name": {
"type": [
"string",
"null"
]
},
"surname": {
"type": [
"string",
"null"
]
},
"maiden_name": {
"type": [
"string",
"null"
]
},
"gender": {
"anyOf": [
{
"type": "string",
"enum": [
"M",
"F",
"X",
"U"
]
},
{
"type": "null"
}
]
},
"birth": {
"type": "object",
"properties": {
"date": {
"type": [
"string",
"null"
]
},
"year": {
"anyOf": [
{
"type": "integer",
"minimum": -9007199254740991,
"maximum": 9007199254740991
},
{
"type": "null"
}
]
},
"place": {
"type": [
"string",
"null"
]
}
},
"required": [
"date",
"year",
"place"
]
}
},
"required": [
"id",
"display_name",
"given_name",
"surname",
"maiden_name",
"gender",
"birth"
]
},
"description": "Up to 5, best match first."
},
"records": {
"type": "array",
"items": {
"type": "object",
"properties": {
"id": {
"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)$"
},
"title": {
"type": "string"
},
"original_filename": {
"type": "string"
},
"record_type": {
"type": [
"string",
"null"
]
},
"status": {
"type": "string",
"enum": [
"pending",
"processing",
"review",
"confirmed",
"failed"
]
}
},
"required": [
"id",
"title",
"original_filename",
"record_type",
"status"
]
},
"description": "Up to 5, best match first."
},
"places": {
"type": "array",
"items": {
"type": "object",
"properties": {
"id": {
"type": "string"
},
"name": {
"type": "string"
}
},
"required": [
"id",
"name"
]
},
"description": "Up to 3 record event places. A place used only on records that are not confirmed yet has no GET .../places/{place_id} until one is confirmed (404)."
}
},
"required": [
"people",
"records",
"places"
]
}