{"openapi":"3.0.3","info":{"title":"Te Papa Collections API","version":"0.1.0","description":"Te Papa Collections API — read-only access to the museum's collection data.\n\n**Base path.** The canonical, versioned base path is `/api/v4`.\n`/api` (unversioned) and `/collection` (the v3 URL space) are aliases that\nserve identical responses and are kept for existing clients. New integrations\nshould use `/api/v4`.\n\n**Identification, not authorisation.** This API publishes open collection data\nand has no per-consumer entitlements: every authenticated caller can read the\nsame records. API keys therefore *identify* the consuming application (for\nattribution, support and usage monitoring); they do not grant or scope access.\nBecause no client is being *authorised* to act on protected resources, OAuth\n2.1 is not used. Send your key in the `X-API-Key` header — never in the URL.\nRegister for a key at `/api/_register/`.\n\nA daily-rotating guest key is prefilled in the API browser at `/docs/apibrowser`\nfor exploration. It is rate limited, capped at 100 results per page, and cannot\nuse the scroll endpoints.\n\n**Correlation.** Send `X-Correlation-Id` (a UUID is recommended) and it is\nechoed on the response, recorded in our logs, and included as\n`correlationId` in any error body. `X-Request-Id` is accepted as an alias.\nIf neither is sent, one is generated."},"components":{"securitySchemes":{"apiKey":{"type":"apiKey","in":"header","name":"X-API-Key","description":"Identifies the consuming application. Grants no scoped permissions — see the API description."}},"schemas":{}},"paths":{"/api/v4/object":{"get":{"parameters":[{"schema":{"type":"string"},"in":"query","name":"q","required":false,"description":"search query to run"},{"schema":{"anyOf":[{"type":"string","enum":["AND"]},{"type":"string","enum":["OR"]}]},"in":"query","name":"defaultoperator","required":false,"description":"the default boolean operator to use on terms in the search query (optional)"},{"schema":{"type":"string"},"in":"query","name":"fields","required":false,"description":"comma-separated list of fields to include in each result record (optional).\nTo exclude a field, prepend a minus to a field name; use no prefix to include it.\ninclude title and date modified: title,_meta.modified\nexclude title: -title\nIf this parameter is not set, all known fields are included."},{"schema":{"minimum":0,"type":"integer"},"in":"query","name":"from","required":false,"description":"the first result to include (optional)"},{"schema":{"minimum":0,"type":"integer"},"in":"query","name":"size","required":false,"description":"the number of results to return, -1 for default page size (optional)"},{"schema":{"minimum":0,"type":"integer"},"in":"query","name":"offset","required":false,"description":"alias of from (optional)"},{"schema":{"minimum":-1,"type":"integer"},"in":"query","name":"limit","required":false,"description":"alias of size (optional)"},{"schema":{"type":"string"},"in":"query","name":"sort","required":false,"description":"the field and order to sort on (optional).\nTo sort in descending order, prepend a minus to the field name. Examples:\nsort on title ascending: title\nsort on creation date descending: -_meta.created\nIf this parameter is not set, results are sorted by descending relevance score."}],"responses":{"200":{"description":"Default Response"}}}},"/api/v4/object/_scroll":{"post":{"parameters":[{"schema":{"type":"string"},"in":"query","name":"q","required":false,"description":"search query to run (optional)"},{"schema":{"anyOf":[{"type":"string","enum":["AND"]},{"type":"string","enum":["OR"]}]},"in":"query","name":"defaultoperator","required":false,"description":"the default boolean operator to use on terms in the search query (optional)"},{"schema":{"type":"string"},"in":"query","name":"fields","required":false,"description":"list of fields to include in each result record (optional)"},{"schema":{"minimum":1,"type":"integer"},"in":"query","name":"size","required":false,"description":"the size of each individual scroll response (optional)"},{"schema":{"type":"integer"},"in":"query","name":"duration","required":false,"description":"the duration this scroll should be available for in minutes"}],"responses":{"200":{"description":"Default Response"}}}},"/api/v4/object/{id}":{"get":{"parameters":[{"schema":{"pattern":"^[0-9]+$","maxLength":64,"type":"string"},"in":"path","name":"id","required":true,"description":"the ID of the record to look up"}],"responses":{"200":{"description":"Default Response"}}}},"/api/v4/object/{id}/related":{"get":{"parameters":[{"schema":{"type":"string"},"in":"query","name":"associations","required":false,"description":"comma-separated list of associations (optional)"},{"schema":{"type":"string"},"in":"query","name":"types","required":false,"description":"types to include in the response (optional)"},{"schema":{"type":"string"},"in":"query","name":"fields","required":false,"description":"fields to include/exclude in the response (optional)"},{"schema":{"minimum":0,"type":"integer"},"in":"query","name":"from","required":false,"description":"the first result to include (optional)"},{"schema":{"minimum":0,"type":"integer"},"in":"query","name":"size","required":false,"description":"the number of results to return, -1 for default page size (optional)"},{"schema":{"minimum":0,"type":"integer"},"in":"query","name":"offset","required":false,"description":"alias of from (optional)"},{"schema":{"minimum":-1,"type":"integer"},"in":"query","name":"limit","required":false,"description":"alias of size (optional)"},{"schema":{"pattern":"^[0-9]+$","maxLength":64,"type":"string"},"in":"path","name":"id","required":true,"description":"the ID of the record to look up relations for"}],"responses":{"200":{"description":"Default Response"}}}},"/api/v4/media":{"get":{"parameters":[{"schema":{"type":"string"},"in":"query","name":"q","required":false,"description":"search query to run"},{"schema":{"anyOf":[{"type":"string","enum":["AND"]},{"type":"string","enum":["OR"]}]},"in":"query","name":"defaultoperator","required":false,"description":"the default boolean operator to use on terms in the search query (optional)"},{"schema":{"type":"string"},"in":"query","name":"fields","required":false,"description":"comma-separated list of fields to include in each result record (optional).\nTo exclude a field, prepend a minus to a field name; use no prefix to include it.\ninclude title and date modified: title,_meta.modified\nexclude title: -title\nIf this parameter is not set, all known fields are included."},{"schema":{"minimum":0,"type":"integer"},"in":"query","name":"from","required":false,"description":"the first result to include (optional)"},{"schema":{"minimum":0,"type":"integer"},"in":"query","name":"size","required":false,"description":"the number of results to return, -1 for default page size (optional)"},{"schema":{"minimum":0,"type":"integer"},"in":"query","name":"offset","required":false,"description":"alias of from (optional)"},{"schema":{"minimum":-1,"type":"integer"},"in":"query","name":"limit","required":false,"description":"alias of size (optional)"},{"schema":{"type":"string"},"in":"query","name":"sort","required":false,"description":"the field and order to sort on (optional).\nTo sort in descending order, prepend a minus to the field name. Examples:\nsort on title ascending: title\nsort on creation date descending: -_meta.created\nIf this parameter is not set, results are sorted by descending relevance score."}],"responses":{"200":{"description":"Default Response"}}}},"/api/v4/media/_scroll":{"post":{"parameters":[{"schema":{"type":"string"},"in":"query","name":"q","required":false,"description":"search query to run (optional)"},{"schema":{"anyOf":[{"type":"string","enum":["AND"]},{"type":"string","enum":["OR"]}]},"in":"query","name":"defaultoperator","required":false,"description":"the default boolean operator to use on terms in the search query (optional)"},{"schema":{"type":"string"},"in":"query","name":"fields","required":false,"description":"list of fields to include in each result record (optional)"},{"schema":{"minimum":1,"type":"integer"},"in":"query","name":"size","required":false,"description":"the size of each individual scroll response (optional)"},{"schema":{"type":"integer"},"in":"query","name":"duration","required":false,"description":"the duration this scroll should be available for in minutes"}],"responses":{"200":{"description":"Default Response"}}}},"/api/v4/media/{id}":{"get":{"parameters":[{"schema":{"pattern":"^[0-9]+$","maxLength":64,"type":"string"},"in":"path","name":"id","required":true,"description":"the ID of the record to look up"}],"responses":{"200":{"description":"Default Response"}}}},"/api/v4/media/{id}/related":{"get":{"parameters":[{"schema":{"type":"string"},"in":"query","name":"associations","required":false,"description":"comma-separated list of associations (optional)"},{"schema":{"type":"string"},"in":"query","name":"types","required":false,"description":"types to include in the response (optional)"},{"schema":{"type":"string"},"in":"query","name":"fields","required":false,"description":"fields to include/exclude in the response (optional)"},{"schema":{"minimum":0,"type":"integer"},"in":"query","name":"from","required":false,"description":"the first result to include (optional)"},{"schema":{"minimum":0,"type":"integer"},"in":"query","name":"size","required":false,"description":"the number of results to return, -1 for default page size (optional)"},{"schema":{"minimum":0,"type":"integer"},"in":"query","name":"offset","required":false,"description":"alias of from (optional)"},{"schema":{"minimum":-1,"type":"integer"},"in":"query","name":"limit","required":false,"description":"alias of size (optional)"},{"schema":{"pattern":"^[0-9]+$","maxLength":64,"type":"string"},"in":"path","name":"id","required":true,"description":"the ID of the record to look up relations for"}],"responses":{"200":{"description":"Default Response"}}}},"/api/v4/topic":{"get":{"parameters":[{"schema":{"type":"string"},"in":"query","name":"q","required":false,"description":"search query to run"},{"schema":{"anyOf":[{"type":"string","enum":["AND"]},{"type":"string","enum":["OR"]}]},"in":"query","name":"defaultoperator","required":false,"description":"the default boolean operator to use on terms in the search query (optional)"},{"schema":{"type":"string"},"in":"query","name":"fields","required":false,"description":"comma-separated list of fields to include in each result record (optional).\nTo exclude a field, prepend a minus to a field name; use no prefix to include it.\ninclude title and date modified: title,_meta.modified\nexclude title: -title\nIf this parameter is not set, all known fields are included."},{"schema":{"minimum":0,"type":"integer"},"in":"query","name":"from","required":false,"description":"the first result to include (optional)"},{"schema":{"minimum":0,"type":"integer"},"in":"query","name":"size","required":false,"description":"the number of results to return, -1 for default page size (optional)"},{"schema":{"minimum":0,"type":"integer"},"in":"query","name":"offset","required":false,"description":"alias of from (optional)"},{"schema":{"minimum":-1,"type":"integer"},"in":"query","name":"limit","required":false,"description":"alias of size (optional)"},{"schema":{"type":"string"},"in":"query","name":"sort","required":false,"description":"the field and order to sort on (optional).\nTo sort in descending order, prepend a minus to the field name. Examples:\nsort on title ascending: title\nsort on creation date descending: -_meta.created\nIf this parameter is not set, results are sorted by descending relevance score."}],"responses":{"200":{"description":"Default Response"}}}},"/api/v4/topic/_scroll":{"post":{"parameters":[{"schema":{"type":"string"},"in":"query","name":"q","required":false,"description":"search query to run (optional)"},{"schema":{"anyOf":[{"type":"string","enum":["AND"]},{"type":"string","enum":["OR"]}]},"in":"query","name":"defaultoperator","required":false,"description":"the default boolean operator to use on terms in the search query (optional)"},{"schema":{"type":"string"},"in":"query","name":"fields","required":false,"description":"list of fields to include in each result record (optional)"},{"schema":{"minimum":1,"type":"integer"},"in":"query","name":"size","required":false,"description":"the size of each individual scroll response (optional)"},{"schema":{"type":"integer"},"in":"query","name":"duration","required":false,"description":"the duration this scroll should be available for in minutes"}],"responses":{"200":{"description":"Default Response"}}}},"/api/v4/topic/{id}":{"get":{"parameters":[{"schema":{"pattern":"^[0-9]+$","maxLength":64,"type":"string"},"in":"path","name":"id","required":true,"description":"the ID of the record to look up"}],"responses":{"200":{"description":"Default Response"}}}},"/api/v4/topic/{id}/related":{"get":{"parameters":[{"schema":{"type":"string"},"in":"query","name":"associations","required":false,"description":"comma-separated list of associations (optional)"},{"schema":{"type":"string"},"in":"query","name":"types","required":false,"description":"types to include in the response (optional)"},{"schema":{"type":"string"},"in":"query","name":"fields","required":false,"description":"fields to include/exclude in the response (optional)"},{"schema":{"minimum":0,"type":"integer"},"in":"query","name":"from","required":false,"description":"the first result to include (optional)"},{"schema":{"minimum":0,"type":"integer"},"in":"query","name":"size","required":false,"description":"the number of results to return, -1 for default page size (optional)"},{"schema":{"minimum":0,"type":"integer"},"in":"query","name":"offset","required":false,"description":"alias of from (optional)"},{"schema":{"minimum":-1,"type":"integer"},"in":"query","name":"limit","required":false,"description":"alias of size (optional)"},{"schema":{"pattern":"^[0-9]+$","maxLength":64,"type":"string"},"in":"path","name":"id","required":true,"description":"the ID of the record to look up relations for"}],"responses":{"200":{"description":"Default Response"}}}},"/api/v4/group":{"get":{"parameters":[{"schema":{"type":"string"},"in":"query","name":"q","required":false,"description":"search query to run"},{"schema":{"anyOf":[{"type":"string","enum":["AND"]},{"type":"string","enum":["OR"]}]},"in":"query","name":"defaultoperator","required":false,"description":"the default boolean operator to use on terms in the search query (optional)"},{"schema":{"type":"string"},"in":"query","name":"fields","required":false,"description":"comma-separated list of fields to include in each result record (optional).\nTo exclude a field, prepend a minus to a field name; use no prefix to include it.\ninclude title and date modified: title,_meta.modified\nexclude title: -title\nIf this parameter is not set, all known fields are included."},{"schema":{"minimum":0,"type":"integer"},"in":"query","name":"from","required":false,"description":"the first result to include (optional)"},{"schema":{"minimum":0,"type":"integer"},"in":"query","name":"size","required":false,"description":"the number of results to return, -1 for default page size (optional)"},{"schema":{"minimum":0,"type":"integer"},"in":"query","name":"offset","required":false,"description":"alias of from (optional)"},{"schema":{"minimum":-1,"type":"integer"},"in":"query","name":"limit","required":false,"description":"alias of size (optional)"},{"schema":{"type":"string"},"in":"query","name":"sort","required":false,"description":"the field and order to sort on (optional).\nTo sort in descending order, prepend a minus to the field name. Examples:\nsort on title ascending: title\nsort on creation date descending: -_meta.created\nIf this parameter is not set, results are sorted by descending relevance score."}],"responses":{"200":{"description":"Default Response"}}}},"/api/v4/group/_scroll":{"post":{"parameters":[{"schema":{"type":"string"},"in":"query","name":"q","required":false,"description":"search query to run (optional)"},{"schema":{"anyOf":[{"type":"string","enum":["AND"]},{"type":"string","enum":["OR"]}]},"in":"query","name":"defaultoperator","required":false,"description":"the default boolean operator to use on terms in the search query (optional)"},{"schema":{"type":"string"},"in":"query","name":"fields","required":false,"description":"list of fields to include in each result record (optional)"},{"schema":{"minimum":1,"type":"integer"},"in":"query","name":"size","required":false,"description":"the size of each individual scroll response (optional)"},{"schema":{"type":"integer"},"in":"query","name":"duration","required":false,"description":"the duration this scroll should be available for in minutes"}],"responses":{"200":{"description":"Default Response"}}}},"/api/v4/group/{id}":{"get":{"parameters":[{"schema":{"pattern":"^[0-9]+$","maxLength":64,"type":"string"},"in":"path","name":"id","required":true,"description":"the ID of the record to look up"}],"responses":{"200":{"description":"Default Response"}}}},"/api/v4/group/{id}/related":{"get":{"parameters":[{"schema":{"type":"string"},"in":"query","name":"associations","required":false,"description":"comma-separated list of associations (optional)"},{"schema":{"type":"string"},"in":"query","name":"types","required":false,"description":"types to include in the response (optional)"},{"schema":{"type":"string"},"in":"query","name":"fields","required":false,"description":"fields to include/exclude in the response (optional)"},{"schema":{"minimum":0,"type":"integer"},"in":"query","name":"from","required":false,"description":"the first result to include (optional)"},{"schema":{"minimum":0,"type":"integer"},"in":"query","name":"size","required":false,"description":"the number of results to return, -1 for default page size (optional)"},{"schema":{"minimum":0,"type":"integer"},"in":"query","name":"offset","required":false,"description":"alias of from (optional)"},{"schema":{"minimum":-1,"type":"integer"},"in":"query","name":"limit","required":false,"description":"alias of size (optional)"},{"schema":{"pattern":"^[0-9]+$","maxLength":64,"type":"string"},"in":"path","name":"id","required":true,"description":"the ID of the record to look up relations for"}],"responses":{"200":{"description":"Default Response"}}}},"/api/v4/fieldcollection":{"get":{"parameters":[{"schema":{"type":"string"},"in":"query","name":"q","required":false,"description":"search query to run"},{"schema":{"anyOf":[{"type":"string","enum":["AND"]},{"type":"string","enum":["OR"]}]},"in":"query","name":"defaultoperator","required":false,"description":"the default boolean operator to use on terms in the search query (optional)"},{"schema":{"type":"string"},"in":"query","name":"fields","required":false,"description":"comma-separated list of fields to include in each result record (optional).\nTo exclude a field, prepend a minus to a field name; use no prefix to include it.\ninclude title and date modified: title,_meta.modified\nexclude title: -title\nIf this parameter is not set, all known fields are included."},{"schema":{"minimum":0,"type":"integer"},"in":"query","name":"from","required":false,"description":"the first result to include (optional)"},{"schema":{"minimum":0,"type":"integer"},"in":"query","name":"size","required":false,"description":"the number of results to return, -1 for default page size (optional)"},{"schema":{"minimum":0,"type":"integer"},"in":"query","name":"offset","required":false,"description":"alias of from (optional)"},{"schema":{"minimum":-1,"type":"integer"},"in":"query","name":"limit","required":false,"description":"alias of size (optional)"},{"schema":{"type":"string"},"in":"query","name":"sort","required":false,"description":"the field and order to sort on (optional).\nTo sort in descending order, prepend a minus to the field name. Examples:\nsort on title ascending: title\nsort on creation date descending: -_meta.created\nIf this parameter is not set, results are sorted by descending relevance score."}],"responses":{"200":{"description":"Default Response"}}}},"/api/v4/fieldcollection/_scroll":{"post":{"parameters":[{"schema":{"type":"string"},"in":"query","name":"q","required":false,"description":"search query to run (optional)"},{"schema":{"anyOf":[{"type":"string","enum":["AND"]},{"type":"string","enum":["OR"]}]},"in":"query","name":"defaultoperator","required":false,"description":"the default boolean operator to use on terms in the search query (optional)"},{"schema":{"type":"string"},"in":"query","name":"fields","required":false,"description":"list of fields to include in each result record (optional)"},{"schema":{"minimum":1,"type":"integer"},"in":"query","name":"size","required":false,"description":"the size of each individual scroll response (optional)"},{"schema":{"type":"integer"},"in":"query","name":"duration","required":false,"description":"the duration this scroll should be available for in minutes"}],"responses":{"200":{"description":"Default Response"}}}},"/api/v4/fieldcollection/{id}":{"get":{"parameters":[{"schema":{"pattern":"^[0-9]+$","maxLength":64,"type":"string"},"in":"path","name":"id","required":true,"description":"the ID of the record to look up"}],"responses":{"200":{"description":"Default Response"}}}},"/api/v4/fieldcollection/{id}/related":{"get":{"parameters":[{"schema":{"type":"string"},"in":"query","name":"associations","required":false,"description":"comma-separated list of associations (optional)"},{"schema":{"type":"string"},"in":"query","name":"types","required":false,"description":"types to include in the response (optional)"},{"schema":{"type":"string"},"in":"query","name":"fields","required":false,"description":"fields to include/exclude in the response (optional)"},{"schema":{"minimum":0,"type":"integer"},"in":"query","name":"from","required":false,"description":"the first result to include (optional)"},{"schema":{"minimum":0,"type":"integer"},"in":"query","name":"size","required":false,"description":"the number of results to return, -1 for default page size (optional)"},{"schema":{"minimum":0,"type":"integer"},"in":"query","name":"offset","required":false,"description":"alias of from (optional)"},{"schema":{"minimum":-1,"type":"integer"},"in":"query","name":"limit","required":false,"description":"alias of size (optional)"},{"schema":{"pattern":"^[0-9]+$","maxLength":64,"type":"string"},"in":"path","name":"id","required":true,"description":"the ID of the record to look up relations for"}],"responses":{"200":{"description":"Default Response"}}}},"/api/v4/agent":{"get":{"parameters":[{"schema":{"type":"string"},"in":"query","name":"q","required":false,"description":"search query to run"},{"schema":{"anyOf":[{"type":"string","enum":["AND"]},{"type":"string","enum":["OR"]}]},"in":"query","name":"defaultoperator","required":false,"description":"the default boolean operator to use on terms in the search query (optional)"},{"schema":{"type":"string"},"in":"query","name":"fields","required":false,"description":"comma-separated list of fields to include in each result record (optional).\nTo exclude a field, prepend a minus to a field name; use no prefix to include it.\ninclude title and date modified: title,_meta.modified\nexclude title: -title\nIf this parameter is not set, all known fields are included."},{"schema":{"minimum":0,"type":"integer"},"in":"query","name":"from","required":false,"description":"the first result to include (optional)"},{"schema":{"minimum":0,"type":"integer"},"in":"query","name":"size","required":false,"description":"the number of results to return, -1 for default page size (optional)"},{"schema":{"minimum":0,"type":"integer"},"in":"query","name":"offset","required":false,"description":"alias of from (optional)"},{"schema":{"minimum":-1,"type":"integer"},"in":"query","name":"limit","required":false,"description":"alias of size (optional)"},{"schema":{"type":"string"},"in":"query","name":"sort","required":false,"description":"the field and order to sort on (optional).\nTo sort in descending order, prepend a minus to the field name. Examples:\nsort on title ascending: title\nsort on creation date descending: -_meta.created\nIf this parameter is not set, results are sorted by descending relevance score."}],"responses":{"200":{"description":"Default Response"}}}},"/api/v4/agent/_scroll":{"post":{"parameters":[{"schema":{"type":"string"},"in":"query","name":"q","required":false,"description":"search query to run (optional)"},{"schema":{"anyOf":[{"type":"string","enum":["AND"]},{"type":"string","enum":["OR"]}]},"in":"query","name":"defaultoperator","required":false,"description":"the default boolean operator to use on terms in the search query (optional)"},{"schema":{"type":"string"},"in":"query","name":"fields","required":false,"description":"list of fields to include in each result record (optional)"},{"schema":{"minimum":1,"type":"integer"},"in":"query","name":"size","required":false,"description":"the size of each individual scroll response (optional)"},{"schema":{"type":"integer"},"in":"query","name":"duration","required":false,"description":"the duration this scroll should be available for in minutes"}],"responses":{"200":{"description":"Default Response"}}}},"/api/v4/agent/{id}":{"get":{"parameters":[{"schema":{"pattern":"^[0-9]+$","maxLength":64,"type":"string"},"in":"path","name":"id","required":true,"description":"the ID of the record to look up"}],"responses":{"200":{"description":"Default Response"}}}},"/api/v4/agent/{id}/related":{"get":{"parameters":[{"schema":{"type":"string"},"in":"query","name":"associations","required":false,"description":"comma-separated list of associations (optional)"},{"schema":{"type":"string"},"in":"query","name":"types","required":false,"description":"types to include in the response (optional)"},{"schema":{"type":"string"},"in":"query","name":"fields","required":false,"description":"fields to include/exclude in the response (optional)"},{"schema":{"minimum":0,"type":"integer"},"in":"query","name":"from","required":false,"description":"the first result to include (optional)"},{"schema":{"minimum":0,"type":"integer"},"in":"query","name":"size","required":false,"description":"the number of results to return, -1 for default page size (optional)"},{"schema":{"minimum":0,"type":"integer"},"in":"query","name":"offset","required":false,"description":"alias of from (optional)"},{"schema":{"minimum":-1,"type":"integer"},"in":"query","name":"limit","required":false,"description":"alias of size (optional)"},{"schema":{"pattern":"^[0-9]+$","maxLength":64,"type":"string"},"in":"path","name":"id","required":true,"description":"the ID of the record to look up relations for"}],"responses":{"200":{"description":"Default Response"}}}},"/api/v4/document":{"get":{"parameters":[{"schema":{"type":"string"},"in":"query","name":"q","required":false,"description":"search query to run"},{"schema":{"anyOf":[{"type":"string","enum":["AND"]},{"type":"string","enum":["OR"]}]},"in":"query","name":"defaultoperator","required":false,"description":"the default boolean operator to use on terms in the search query (optional)"},{"schema":{"type":"string"},"in":"query","name":"fields","required":false,"description":"comma-separated list of fields to include in each result record (optional).\nTo exclude a field, prepend a minus to a field name; use no prefix to include it.\ninclude title and date modified: title,_meta.modified\nexclude title: -title\nIf this parameter is not set, all known fields are included."},{"schema":{"minimum":0,"type":"integer"},"in":"query","name":"from","required":false,"description":"the first result to include (optional)"},{"schema":{"minimum":0,"type":"integer"},"in":"query","name":"size","required":false,"description":"the number of results to return, -1 for default page size (optional)"},{"schema":{"minimum":0,"type":"integer"},"in":"query","name":"offset","required":false,"description":"alias of from (optional)"},{"schema":{"minimum":-1,"type":"integer"},"in":"query","name":"limit","required":false,"description":"alias of size (optional)"},{"schema":{"type":"string"},"in":"query","name":"sort","required":false,"description":"the field and order to sort on (optional).\nTo sort in descending order, prepend a minus to the field name. Examples:\nsort on title ascending: title\nsort on creation date descending: -_meta.created\nIf this parameter is not set, results are sorted by descending relevance score."}],"responses":{"200":{"description":"Default Response"}}}},"/api/v4/document/_scroll":{"post":{"parameters":[{"schema":{"type":"string"},"in":"query","name":"q","required":false,"description":"search query to run (optional)"},{"schema":{"anyOf":[{"type":"string","enum":["AND"]},{"type":"string","enum":["OR"]}]},"in":"query","name":"defaultoperator","required":false,"description":"the default boolean operator to use on terms in the search query (optional)"},{"schema":{"type":"string"},"in":"query","name":"fields","required":false,"description":"list of fields to include in each result record (optional)"},{"schema":{"minimum":1,"type":"integer"},"in":"query","name":"size","required":false,"description":"the size of each individual scroll response (optional)"},{"schema":{"type":"integer"},"in":"query","name":"duration","required":false,"description":"the duration this scroll should be available for in minutes"}],"responses":{"200":{"description":"Default Response"}}}},"/api/v4/document/{id}":{"get":{"parameters":[{"schema":{"pattern":"^[0-9]+$","maxLength":64,"type":"string"},"in":"path","name":"id","required":true,"description":"the ID of the record to look up"}],"responses":{"200":{"description":"Default Response"}}}},"/api/v4/document/{id}/related":{"get":{"parameters":[{"schema":{"type":"string"},"in":"query","name":"associations","required":false,"description":"comma-separated list of associations (optional)"},{"schema":{"type":"string"},"in":"query","name":"types","required":false,"description":"types to include in the response (optional)"},{"schema":{"type":"string"},"in":"query","name":"fields","required":false,"description":"fields to include/exclude in the response (optional)"},{"schema":{"minimum":0,"type":"integer"},"in":"query","name":"from","required":false,"description":"the first result to include (optional)"},{"schema":{"minimum":0,"type":"integer"},"in":"query","name":"size","required":false,"description":"the number of results to return, -1 for default page size (optional)"},{"schema":{"minimum":0,"type":"integer"},"in":"query","name":"offset","required":false,"description":"alias of from (optional)"},{"schema":{"minimum":-1,"type":"integer"},"in":"query","name":"limit","required":false,"description":"alias of size (optional)"},{"schema":{"pattern":"^[0-9]+$","maxLength":64,"type":"string"},"in":"path","name":"id","required":true,"description":"the ID of the record to look up relations for"}],"responses":{"200":{"description":"Default Response"}}}},"/api/v4/place":{"get":{"parameters":[{"schema":{"type":"string"},"in":"query","name":"q","required":false,"description":"search query to run"},{"schema":{"anyOf":[{"type":"string","enum":["AND"]},{"type":"string","enum":["OR"]}]},"in":"query","name":"defaultoperator","required":false,"description":"the default boolean operator to use on terms in the search query (optional)"},{"schema":{"type":"string"},"in":"query","name":"fields","required":false,"description":"comma-separated list of fields to include in each result record (optional).\nTo exclude a field, prepend a minus to a field name; use no prefix to include it.\ninclude title and date modified: title,_meta.modified\nexclude title: -title\nIf this parameter is not set, all known fields are included."},{"schema":{"minimum":0,"type":"integer"},"in":"query","name":"from","required":false,"description":"the first result to include (optional)"},{"schema":{"minimum":0,"type":"integer"},"in":"query","name":"size","required":false,"description":"the number of results to return, -1 for default page size (optional)"},{"schema":{"minimum":0,"type":"integer"},"in":"query","name":"offset","required":false,"description":"alias of from (optional)"},{"schema":{"minimum":-1,"type":"integer"},"in":"query","name":"limit","required":false,"description":"alias of size (optional)"},{"schema":{"type":"string"},"in":"query","name":"sort","required":false,"description":"the field and order to sort on (optional).\nTo sort in descending order, prepend a minus to the field name. Examples:\nsort on title ascending: title\nsort on creation date descending: -_meta.created\nIf this parameter is not set, results are sorted by descending relevance score."}],"responses":{"200":{"description":"Default Response"}}}},"/api/v4/place/_scroll":{"post":{"parameters":[{"schema":{"type":"string"},"in":"query","name":"q","required":false,"description":"search query to run (optional)"},{"schema":{"anyOf":[{"type":"string","enum":["AND"]},{"type":"string","enum":["OR"]}]},"in":"query","name":"defaultoperator","required":false,"description":"the default boolean operator to use on terms in the search query (optional)"},{"schema":{"type":"string"},"in":"query","name":"fields","required":false,"description":"list of fields to include in each result record (optional)"},{"schema":{"minimum":1,"type":"integer"},"in":"query","name":"size","required":false,"description":"the size of each individual scroll response (optional)"},{"schema":{"type":"integer"},"in":"query","name":"duration","required":false,"description":"the duration this scroll should be available for in minutes"}],"responses":{"200":{"description":"Default Response"}}}},"/api/v4/place/{id}":{"get":{"parameters":[{"schema":{"pattern":"^[0-9]+$","maxLength":64,"type":"string"},"in":"path","name":"id","required":true,"description":"the ID of the record to look up"}],"responses":{"200":{"description":"Default Response"}}}},"/api/v4/place/{id}/related":{"get":{"parameters":[{"schema":{"type":"string"},"in":"query","name":"associations","required":false,"description":"comma-separated list of associations (optional)"},{"schema":{"type":"string"},"in":"query","name":"types","required":false,"description":"types to include in the response (optional)"},{"schema":{"type":"string"},"in":"query","name":"fields","required":false,"description":"fields to include/exclude in the response (optional)"},{"schema":{"minimum":0,"type":"integer"},"in":"query","name":"from","required":false,"description":"the first result to include (optional)"},{"schema":{"minimum":0,"type":"integer"},"in":"query","name":"size","required":false,"description":"the number of results to return, -1 for default page size (optional)"},{"schema":{"minimum":0,"type":"integer"},"in":"query","name":"offset","required":false,"description":"alias of from (optional)"},{"schema":{"minimum":-1,"type":"integer"},"in":"query","name":"limit","required":false,"description":"alias of size (optional)"},{"schema":{"pattern":"^[0-9]+$","maxLength":64,"type":"string"},"in":"path","name":"id","required":true,"description":"the ID of the record to look up relations for"}],"responses":{"200":{"description":"Default Response"}}}},"/api/v4/taxon":{"get":{"parameters":[{"schema":{"type":"string"},"in":"query","name":"q","required":false,"description":"search query to run"},{"schema":{"anyOf":[{"type":"string","enum":["AND"]},{"type":"string","enum":["OR"]}]},"in":"query","name":"defaultoperator","required":false,"description":"the default boolean operator to use on terms in the search query (optional)"},{"schema":{"type":"string"},"in":"query","name":"fields","required":false,"description":"comma-separated list of fields to include in each result record (optional).\nTo exclude a field, prepend a minus to a field name; use no prefix to include it.\ninclude title and date modified: title,_meta.modified\nexclude title: -title\nIf this parameter is not set, all known fields are included."},{"schema":{"minimum":0,"type":"integer"},"in":"query","name":"from","required":false,"description":"the first result to include (optional)"},{"schema":{"minimum":0,"type":"integer"},"in":"query","name":"size","required":false,"description":"the number of results to return, -1 for default page size (optional)"},{"schema":{"minimum":0,"type":"integer"},"in":"query","name":"offset","required":false,"description":"alias of from (optional)"},{"schema":{"minimum":-1,"type":"integer"},"in":"query","name":"limit","required":false,"description":"alias of size (optional)"},{"schema":{"type":"string"},"in":"query","name":"sort","required":false,"description":"the field and order to sort on (optional).\nTo sort in descending order, prepend a minus to the field name. Examples:\nsort on title ascending: title\nsort on creation date descending: -_meta.created\nIf this parameter is not set, results are sorted by descending relevance score."}],"responses":{"200":{"description":"Default Response"}}}},"/api/v4/taxon/_scroll":{"post":{"parameters":[{"schema":{"type":"string"},"in":"query","name":"q","required":false,"description":"search query to run (optional)"},{"schema":{"anyOf":[{"type":"string","enum":["AND"]},{"type":"string","enum":["OR"]}]},"in":"query","name":"defaultoperator","required":false,"description":"the default boolean operator to use on terms in the search query (optional)"},{"schema":{"type":"string"},"in":"query","name":"fields","required":false,"description":"list of fields to include in each result record (optional)"},{"schema":{"minimum":1,"type":"integer"},"in":"query","name":"size","required":false,"description":"the size of each individual scroll response (optional)"},{"schema":{"type":"integer"},"in":"query","name":"duration","required":false,"description":"the duration this scroll should be available for in minutes"}],"responses":{"200":{"description":"Default Response"}}}},"/api/v4/taxon/{id}":{"get":{"parameters":[{"schema":{"pattern":"^[0-9]+$","maxLength":64,"type":"string"},"in":"path","name":"id","required":true,"description":"the ID of the record to look up"}],"responses":{"200":{"description":"Default Response"}}}},"/api/v4/taxon/{id}/related":{"get":{"parameters":[{"schema":{"type":"string"},"in":"query","name":"associations","required":false,"description":"comma-separated list of associations (optional)"},{"schema":{"type":"string"},"in":"query","name":"types","required":false,"description":"types to include in the response (optional)"},{"schema":{"type":"string"},"in":"query","name":"fields","required":false,"description":"fields to include/exclude in the response (optional)"},{"schema":{"minimum":0,"type":"integer"},"in":"query","name":"from","required":false,"description":"the first result to include (optional)"},{"schema":{"minimum":0,"type":"integer"},"in":"query","name":"size","required":false,"description":"the number of results to return, -1 for default page size (optional)"},{"schema":{"minimum":0,"type":"integer"},"in":"query","name":"offset","required":false,"description":"alias of from (optional)"},{"schema":{"minimum":-1,"type":"integer"},"in":"query","name":"limit","required":false,"description":"alias of size (optional)"},{"schema":{"pattern":"^[0-9]+$","maxLength":64,"type":"string"},"in":"path","name":"id","required":true,"description":"the ID of the record to look up relations for"}],"responses":{"200":{"description":"Default Response"}}}},"/api/v4/category":{"get":{"parameters":[{"schema":{"type":"string"},"in":"query","name":"q","required":false,"description":"search query to run"},{"schema":{"anyOf":[{"type":"string","enum":["AND"]},{"type":"string","enum":["OR"]}]},"in":"query","name":"defaultoperator","required":false,"description":"the default boolean operator to use on terms in the search query (optional)"},{"schema":{"type":"string"},"in":"query","name":"fields","required":false,"description":"comma-separated list of fields to include in each result record (optional).\nTo exclude a field, prepend a minus to a field name; use no prefix to include it.\ninclude title and date modified: title,_meta.modified\nexclude title: -title\nIf this parameter is not set, all known fields are included."},{"schema":{"minimum":0,"type":"integer"},"in":"query","name":"from","required":false,"description":"the first result to include (optional)"},{"schema":{"minimum":0,"type":"integer"},"in":"query","name":"size","required":false,"description":"the number of results to return, -1 for default page size (optional)"},{"schema":{"minimum":0,"type":"integer"},"in":"query","name":"offset","required":false,"description":"alias of from (optional)"},{"schema":{"minimum":-1,"type":"integer"},"in":"query","name":"limit","required":false,"description":"alias of size (optional)"},{"schema":{"type":"string"},"in":"query","name":"sort","required":false,"description":"the field and order to sort on (optional).\nTo sort in descending order, prepend a minus to the field name. Examples:\nsort on title ascending: title\nsort on creation date descending: -_meta.created\nIf this parameter is not set, results are sorted by descending relevance score."}],"responses":{"200":{"description":"Default Response"}}}},"/api/v4/category/_scroll":{"post":{"parameters":[{"schema":{"type":"string"},"in":"query","name":"q","required":false,"description":"search query to run (optional)"},{"schema":{"anyOf":[{"type":"string","enum":["AND"]},{"type":"string","enum":["OR"]}]},"in":"query","name":"defaultoperator","required":false,"description":"the default boolean operator to use on terms in the search query (optional)"},{"schema":{"type":"string"},"in":"query","name":"fields","required":false,"description":"list of fields to include in each result record (optional)"},{"schema":{"minimum":1,"type":"integer"},"in":"query","name":"size","required":false,"description":"the size of each individual scroll response (optional)"},{"schema":{"type":"integer"},"in":"query","name":"duration","required":false,"description":"the duration this scroll should be available for in minutes"}],"responses":{"200":{"description":"Default Response"}}}},"/api/v4/category/{id}":{"get":{"parameters":[{"schema":{"pattern":"^[0-9]+$","maxLength":64,"type":"string"},"in":"path","name":"id","required":true,"description":"the ID of the record to look up"}],"responses":{"200":{"description":"Default Response"}}}},"/api/v4/category/{id}/related":{"get":{"parameters":[{"schema":{"type":"string"},"in":"query","name":"associations","required":false,"description":"comma-separated list of associations (optional)"},{"schema":{"type":"string"},"in":"query","name":"types","required":false,"description":"types to include in the response (optional)"},{"schema":{"type":"string"},"in":"query","name":"fields","required":false,"description":"fields to include/exclude in the response (optional)"},{"schema":{"minimum":0,"type":"integer"},"in":"query","name":"from","required":false,"description":"the first result to include (optional)"},{"schema":{"minimum":0,"type":"integer"},"in":"query","name":"size","required":false,"description":"the number of results to return, -1 for default page size (optional)"},{"schema":{"minimum":0,"type":"integer"},"in":"query","name":"offset","required":false,"description":"alias of from (optional)"},{"schema":{"minimum":-1,"type":"integer"},"in":"query","name":"limit","required":false,"description":"alias of size (optional)"},{"schema":{"pattern":"^[0-9]+$","maxLength":64,"type":"string"},"in":"path","name":"id","required":true,"description":"the ID of the record to look up relations for"}],"responses":{"200":{"description":"Default Response"}}}},"/api/v4/search":{"get":{"parameters":[{"schema":{"type":"string"},"in":"query","name":"q","required":false,"description":"search query to run"},{"schema":{"anyOf":[{"type":"string","enum":["AND"]},{"type":"string","enum":["OR"]}]},"in":"query","name":"defaultoperator","required":false,"description":"the default boolean operator to use on terms in the search query (optional)"},{"schema":{"type":"string"},"in":"query","name":"fields","required":false,"description":"comma-separated list of fields to include in each result record (optional).\nTo exclude a field, prepend a minus to a field name; use no prefix to include it.\ninclude title and date modified: title,_meta.modified\nexclude title: -title\nIf this parameter is not set, all known fields are included."},{"schema":{"minimum":0,"type":"integer"},"in":"query","name":"from","required":false,"description":"the first result to include (optional)"},{"schema":{"minimum":0,"type":"integer"},"in":"query","name":"size","required":false,"description":"the number of results to return, -1 for default page size (optional)"},{"schema":{"minimum":0,"type":"integer"},"in":"query","name":"offset","required":false,"description":"alias of from (optional)"},{"schema":{"minimum":-1,"type":"integer"},"in":"query","name":"limit","required":false,"description":"alias of size (optional)"},{"schema":{"type":"string"},"in":"query","name":"sort","required":false,"description":"the field and order to sort on (optional).\nTo sort in descending order, prepend a minus to the field name. Examples:\nsort on title ascending: title\nsort on creation date descending: -_meta.created\nIf this parameter is not set, results are sorted by descending relevance score."}],"responses":{"200":{"description":"Default Response"}}},"post":{"requestBody":{"required":true,"content":{"application/json":{"schema":{"additionalProperties":false,"description":"A search request allows an API consumer to specify a search query,\nincluding a number of facets, and a sort order.\nIf using the advanced search endpoint, the pagination parameters must be\npassed through this object (the request body).","type":"object","properties":{"query":{"description":"The search query to use (e.g. as entered by the user).\nThe query string is expected to be a valid Elastic Search query string.\nDefaults to \"*\".","type":"string"},"defaultOperator":{"description":"The default boolean operator to use on terms in the search query (optional).\nDefaults to \"OR\".","anyOf":[{"type":"string","enum":["AND"]},{"type":"string","enum":["OR"]}]},"from":{"minimum":0,"description":"Requested page. The first result to include in the response.\nDefaults to 0.","type":"integer"},"size":{"minimum":-1,"description":"Requested page size. The number of results to return.\nUse -1 for maximum size. Defaults to 10.","type":"integer"},"fields":{"description":"Comma-separated list of fields to include/exclude in each result record (optional).\nAdd a \"-\" prefix to a field name to exclude it; use no prefix to include it.\nDefaults to empty (i.e. include all fields).","type":"array","items":{"additionalProperties":false,"type":"object","required":["field"],"properties":{"field":{"description":"The field to include/exclude.","type":"string"},"exclude":{"description":"Whether to exclude this field.","type":"boolean"}}}},"facets":{"description":"Facets (optional).\nOnly supports top-N term facets on:\nSome text fields, e.g. production.spatial.nation or birthPlace.\nFully facetable date fields, e.g. production.createdDate or birthDate.\nReturns multiple aspects for each date field:\ndayOfTheWeek: The day of the week, e.g. \"Monday\"\nmonthOfYear: The month of the year, e.g. \"February\"\nyear: The proleptic year without year 0, including era (if BCE), e.g. \"2015\" or \"200 BCE\"\ndecadeOfCentury: The decade of the century, e.g. \"1920s\"\ncentury: The century, including era (if BCE) e.g. \"13th century\" or \"2nd century BCE\"\nera: The full era, \"Common Era\" (CE) or \"Before Common Era\" (BCE)","type":"array","items":{"additionalProperties":false,"type":"object","required":["field","size"],"properties":{"field":{"description":"The field to facet on.","type":"string"},"size":{"minimum":1,"description":"The number of facets to return.","type":"integer"}}}},"filters":{"description":"Filters (optional).\nSupports keyword filtering on all facetable fields.","type":"array","items":{"additionalProperties":false,"type":"object","required":["field","keyword"],"properties":{"field":{"description":"The field to filter on.","type":"string"},"keyword":{"description":"The keyword to filter on.","type":"string"}}}},"sort":{"description":"Sort order of the results (optional).\nDefaults to descending relevance score.\nOnly some text fields are supported.","type":"array","items":{"additionalProperties":false,"type":"object","required":["field","order"],"properties":{"field":{"description":"The field this order applies to.","type":"string"},"order":{"description":"The sort order.\nOne of asc (ascending) or desc (descending).","anyOf":[{"type":"string","enum":["asc"]},{"type":"string","enum":["desc"]}]}}}}}}}},"description":"A search request allows an API consumer to specify a search query,\nincluding a number of facets, and a sort order.\nIf using the advanced search endpoint, the pagination parameters must be\npassed through this object (the request body)."},"responses":{"200":{"description":"Default Response"}}}},"/api/v4/search/_scroll":{"post":{"parameters":[{"schema":{"type":"string"},"in":"query","name":"q","required":false,"description":"search query to run (optional)"},{"schema":{"anyOf":[{"type":"string","enum":["AND"]},{"type":"string","enum":["OR"]}]},"in":"query","name":"defaultoperator","required":false,"description":"the default boolean operator to use on terms in the search query (optional)"},{"schema":{"type":"string"},"in":"query","name":"fields","required":false,"description":"list of fields to include in each result record (optional)"},{"schema":{"minimum":1,"type":"integer"},"in":"query","name":"size","required":false,"description":"the size of each individual scroll response (optional)"},{"schema":{"type":"integer"},"in":"query","name":"duration","required":false,"description":"the duration this scroll should be available for in minutes"}],"responses":{"200":{"description":"Default Response"}}}},"/api/v4/scroll/{id}":{"get":{"parameters":[{"schema":{"type":"integer"},"in":"query","name":"duration","required":false,"description":"the duration to keep the next scroll alive in minutes"},{"schema":{"minLength":1,"maxLength":4096,"pattern":"^[A-Za-z0-9+/=_-]+$","type":"string"},"in":"path","name":"id","required":true,"description":"the scroll ID to retrieve, obtained by posting to a _scroll endpoint"}],"responses":{"200":{"description":"Default Response"}}}}},"servers":[{"url":"/","description":"This origin"}],"security":[{"apiKey":[]}]}