get
/List families
| Name | In | Required | Description |
|---|---|---|---|
| workspace_id | path | yes | The workspace (project) id. |
| limit | query | no | Page size. Default 25, max 100. |
| cursor | query | no | The next_cursor of the previous page. Opaque. |
Responses
- 200 A page of families. (FamilyList)
- 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 Invalid limit or cursor. (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": {
"data": {
"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)$"
},
"workspace_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)$"
},
"partners": {
"maxItems": 2,
"type": "array",
"items": {
"type": "object",
"properties": {
"person_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)$"
},
"role": {
"type": "string",
"enum": [
"husband",
"wife"
]
}
},
"required": [
"person_id",
"role"
]
}
},
"children": {
"type": "array",
"items": {
"type": "object",
"properties": {
"person_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)$"
},
"pedigree": {
"type": [
"string",
"null"
]
}
},
"required": [
"person_id",
"pedigree"
]
}
},
"marriage": {
"type": "object",
"properties": {
"date": {
"description": "The marriage date as GEDCOM date text (for example \"12 MAY 1892\" or \"ABT 1890\"). \"Y\" means the marriage happened but its date is unknown; null means no marriage is recorded.",
"type": [
"string",
"null"
]
},
"year": {
"anyOf": [
{
"type": "integer",
"minimum": -9007199254740991,
"maximum": 9007199254740991
},
{
"type": "null"
}
]
},
"place": {
"type": [
"string",
"null"
]
},
"type": {
"type": [
"string",
"null"
]
}
},
"required": [
"date",
"year",
"place",
"type"
]
},
"divorce": {
"type": "object",
"properties": {
"date": {
"description": "The divorce date as GEDCOM date text (for example \"12 MAY 1892\" or \"ABT 1890\"). \"Y\" means the divorce happened but its date is unknown; null means no divorce is recorded.",
"type": [
"string",
"null"
]
},
"year": {
"anyOf": [
{
"type": "integer",
"minimum": -9007199254740991,
"maximum": 9007199254740991
},
{
"type": "null"
}
]
},
"place": {
"type": [
"string",
"null"
]
}
},
"required": [
"date",
"year",
"place"
]
},
"created_at": {
"type": "string"
}
},
"required": [
"id",
"workspace_id",
"partners",
"children",
"marriage",
"divorce",
"created_at"
]
}
},
"next_cursor": {
"description": "Pass as ?cursor to get the next page. Null on the last page.",
"type": [
"string",
"null"
]
}
},
"required": [
"data",
"next_cursor"
]
}