--- openapi: 3.0.1 info: title: Trefle API v1 version: 1.6.0 paths: "/api/v1/kingdoms": get: summary: Searches kingdoms tags: - Kingdoms description: List kingdoms operationId: listKingdoms security: - token: [] parameters: - name: page in: query required: false description: The page to fetch schema: type: number responses: '200': description: Success content: application/json: schema: type: object properties: data: type: array items: "$ref": "#/components/schemas/kingdom" links: type: object properties: self: type: string description: A link to the current page of the collection first: type: string description: A link to the first page of the collection next: type: string description: A link to the next page of the collection prev: type: string description: A link to the previous page of the collection last: type: string description: A link to the last page of the collection required: - self meta: type: object properties: total: type: integer examples: returns-a-200-response: value: data: - id: 1 name: Plantae slug: plantae links: self: "/api/v1/kingdoms/plantae" links: self: "/api/v1/kingdoms" first: "/api/v1/kingdoms?page=1" last: "/api/v1/kingdoms?page=1" meta: total: 1 '401': description: Invalid credentials content: application/json: examples: returns-a-401-response: value: error: true messages: Invalid access token "/api/v1/kingdoms/{id}": get: summary: Retrieve a kingdom tags: - Kingdoms description: Get a kingdom operationId: getKingdom parameters: - name: id required: true in: path description: The id or the slug of the requested kingdom schema: type: string security: - token: [] responses: '200': description: Success content: application/json: schema: type: object properties: data: "$ref": "#/components/schemas/kingdom" meta: type: object properties: last_modified: type: string examples: returns-a-200-response: value: data: id: 1 name: Plantae slug: plantae links: self: "/api/v1/kingdoms/plantae" meta: last_modified: '2020-07-22T11:16:26.120Z' '401': description: Invalid credentials content: application/json: examples: returns-a-401-response: value: error: true messages: Invalid access token "/api/v1/subkingdoms": get: summary: Searches subkingdoms tags: - Subkingdoms description: List subkingdoms operationId: listSubkingdoms security: - token: [] parameters: - name: page in: query required: false description: The page to fetch schema: type: number responses: '200': description: Success content: application/json: schema: type: object properties: data: type: array items: "$ref": "#/components/schemas/subkingdom" links: type: object properties: self: type: string description: A link to the current page of the collection first: type: string description: A link to the first page of the collection next: type: string description: A link to the next page of the collection prev: type: string description: A link to the previous page of the collection last: type: string description: A link to the last page of the collection required: - self meta: type: object properties: total: type: integer examples: returns-a-200-response: value: data: - id: 1 name: Tracheobionta slug: tracheobionta links: self: "/api/v1/subkingdoms/tracheobionta" kingdom: "/api/v1/kingdoms/plantae" kingdom: id: 1 name: Plantae slug: plantae links: self: "/api/v1/kingdoms/plantae" links: self: "/api/v1/subkingdoms" first: "/api/v1/subkingdoms?page=1" last: "/api/v1/subkingdoms?page=1" meta: total: 1 '401': description: Invalid credentials content: application/json: examples: returns-a-401-response: value: error: true messages: Invalid access token "/api/v1/subkingdoms/{id}": get: summary: Retrieve a subkingdom tags: - Subkingdoms description: Get a subkingdom operationId: getSubkingdom parameters: - name: id required: true in: path description: The id or the slug of the requested sub-kingdom schema: type: string security: - token: [] responses: '200': description: Success content: application/json: schema: type: object properties: data: "$ref": "#/components/schemas/subkingdom" meta: type: object properties: last_modified: type: string examples: returns-a-200-response: value: data: id: 1 name: Tracheobionta slug: tracheobionta links: self: "/api/v1/subkingdoms/tracheobionta" kingdom: "/api/v1/kingdoms/plantae" kingdom: id: 1 name: Plantae slug: plantae links: self: "/api/v1/kingdoms/plantae" meta: last_modified: '2020-07-22T11:16:26.134Z' '401': description: Invalid credentials content: application/json: examples: returns-a-401-response: value: error: true messages: Invalid access token "/api/v1/divisions": get: summary: Searches divisions tags: - Divisions description: List divisions operationId: listDivisions security: - token: [] parameters: - name: page in: query required: false description: The page to fetch schema: type: number responses: '200': description: Success content: application/json: schema: type: object properties: data: type: array items: "$ref": "#/components/schemas/division" links: type: object properties: self: type: string description: A link to the current page of the collection first: type: string description: A link to the first page of the collection next: type: string description: A link to the next page of the collection prev: type: string description: A link to the previous page of the collection last: type: string description: A link to the last page of the collection required: - self meta: type: object properties: total: type: integer examples: returns-a-200-response: value: data: - id: 1 name: Magnoliophyta slug: magnoliophyta links: self: "/api/v1/divisions/magnoliophyta" subkingdom: "/api/v1/subkingdoms/tracheobionta" subkingdom: id: 1 name: Tracheobionta slug: tracheobionta links: self: "/api/v1/subkingdoms/tracheobionta" kingdom: "/api/v1/kingdoms/plantae" kingdom: id: 1 name: Plantae slug: plantae links: self: "/api/v1/kingdoms/plantae" - id: 2 name: Coniferophyta slug: coniferophyta links: self: "/api/v1/divisions/coniferophyta" subkingdom: "/api/v1/subkingdoms/tracheobionta" subkingdom: id: 1 name: Tracheobionta slug: tracheobionta links: self: "/api/v1/subkingdoms/tracheobionta" kingdom: "/api/v1/kingdoms/plantae" kingdom: id: 1 name: Plantae slug: plantae links: self: "/api/v1/kingdoms/plantae" - id: 3 name: Pteridophyta slug: pteridophyta links: self: "/api/v1/divisions/pteridophyta" subkingdom: "/api/v1/subkingdoms/tracheobionta" subkingdom: id: 1 name: Tracheobionta slug: tracheobionta links: self: "/api/v1/subkingdoms/tracheobionta" kingdom: "/api/v1/kingdoms/plantae" kingdom: id: 1 name: Plantae slug: plantae links: self: "/api/v1/kingdoms/plantae" - id: 4 name: Cycadophyta slug: cycadophyta links: self: "/api/v1/divisions/cycadophyta" subkingdom: "/api/v1/subkingdoms/tracheobionta" subkingdom: id: 1 name: Tracheobionta slug: tracheobionta links: self: "/api/v1/subkingdoms/tracheobionta" kingdom: "/api/v1/kingdoms/plantae" kingdom: id: 1 name: Plantae slug: plantae links: self: "/api/v1/kingdoms/plantae" - id: 5 name: Gnetophyta slug: gnetophyta links: self: "/api/v1/divisions/gnetophyta" subkingdom: "/api/v1/subkingdoms/tracheobionta" subkingdom: id: 1 name: Tracheobionta slug: tracheobionta links: self: "/api/v1/subkingdoms/tracheobionta" kingdom: "/api/v1/kingdoms/plantae" kingdom: id: 1 name: Plantae slug: plantae links: self: "/api/v1/kingdoms/plantae" - id: 6 name: Equisetophyta slug: equisetophyta links: self: "/api/v1/divisions/equisetophyta" subkingdom: "/api/v1/subkingdoms/tracheobionta" subkingdom: id: 1 name: Tracheobionta slug: tracheobionta links: self: "/api/v1/subkingdoms/tracheobionta" kingdom: "/api/v1/kingdoms/plantae" kingdom: id: 1 name: Plantae slug: plantae links: self: "/api/v1/kingdoms/plantae" - id: 7 name: Ginkgophyta slug: ginkgophyta links: self: "/api/v1/divisions/ginkgophyta" subkingdom: "/api/v1/subkingdoms/tracheobionta" subkingdom: id: 1 name: Tracheobionta slug: tracheobionta links: self: "/api/v1/subkingdoms/tracheobionta" kingdom: "/api/v1/kingdoms/plantae" kingdom: id: 1 name: Plantae slug: plantae links: self: "/api/v1/kingdoms/plantae" - id: 8 name: Lycopodiophyta slug: lycopodiophyta links: self: "/api/v1/divisions/lycopodiophyta" subkingdom: "/api/v1/subkingdoms/tracheobionta" subkingdom: id: 1 name: Tracheobionta slug: tracheobionta links: self: "/api/v1/subkingdoms/tracheobionta" kingdom: "/api/v1/kingdoms/plantae" kingdom: id: 1 name: Plantae slug: plantae links: self: "/api/v1/kingdoms/plantae" - id: 9 name: Psilophyta slug: psilophyta links: self: "/api/v1/divisions/psilophyta" subkingdom: "/api/v1/subkingdoms/tracheobionta" subkingdom: id: 1 name: Tracheobionta slug: tracheobionta links: self: "/api/v1/subkingdoms/tracheobionta" kingdom: "/api/v1/kingdoms/plantae" kingdom: id: 1 name: Plantae slug: plantae links: self: "/api/v1/kingdoms/plantae" links: self: "/api/v1/divisions" first: "/api/v1/divisions?page=1" last: "/api/v1/divisions?page=1" meta: total: 9 '401': description: Invalid credentials content: application/json: examples: returns-a-401-response: value: error: true messages: Invalid access token "/api/v1/divisions/{id}": get: summary: Retrieve a division tags: - Divisions description: Get a division operationId: getDivision parameters: - name: id required: true in: path description: The id or the slug of the requested division schema: type: string security: - token: [] responses: '200': description: Success content: application/json: schema: type: object properties: data: "$ref": "#/components/schemas/division" meta: type: object properties: last_modified: type: string examples: returns-a-200-response: value: data: id: 1 name: Magnoliophyta slug: magnoliophyta links: self: "/api/v1/divisions/magnoliophyta" subkingdom: "/api/v1/subkingdoms/tracheobionta" subkingdom: id: 1 name: Tracheobionta slug: tracheobionta links: self: "/api/v1/subkingdoms/tracheobionta" kingdom: "/api/v1/kingdoms/plantae" kingdom: id: 1 name: Plantae slug: plantae links: self: "/api/v1/kingdoms/plantae" meta: last_modified: '2020-07-22T11:16:26.149Z' '401': description: Invalid credentials content: application/json: examples: returns-a-401-response: value: error: true messages: Invalid access token "/api/v1/division_classes": get: summary: Searches division classes tags: - DivisionClasses description: List division classes operationId: listDivisionClasses security: - token: [] parameters: - name: page in: query required: false description: The page to fetch schema: type: number responses: '200': description: Success content: application/json: schema: type: object properties: data: type: array items: "$ref": "#/components/schemas/division_class" links: type: object properties: self: type: string description: A link to the current page of the collection first: type: string description: A link to the first page of the collection next: type: string description: A link to the next page of the collection prev: type: string description: A link to the previous page of the collection last: type: string description: A link to the last page of the collection required: - self meta: type: object properties: total: type: integer examples: returns-a-200-response: value: data: - id: 1 name: Magnoliopsida slug: magnoliopsida links: self: "/api/v1/division_classes/magnoliopsida" division: "/api/v1/divisions/magnoliophyta" division: id: 1 name: Magnoliophyta slug: magnoliophyta links: self: "/api/v1/divisions/magnoliophyta" subkingdom: "/api/v1/subkingdoms/tracheobionta" subkingdom: id: 1 name: Tracheobionta slug: tracheobionta links: self: "/api/v1/subkingdoms/tracheobionta" kingdom: "/api/v1/kingdoms/plantae" kingdom: id: 1 name: Plantae slug: plantae links: self: "/api/v1/kingdoms/plantae" - id: 2 name: Pinopsida slug: pinopsida links: self: "/api/v1/division_classes/pinopsida" division: "/api/v1/divisions/coniferophyta" division: id: 2 name: Coniferophyta slug: coniferophyta links: self: "/api/v1/divisions/coniferophyta" subkingdom: "/api/v1/subkingdoms/tracheobionta" subkingdom: id: 1 name: Tracheobionta slug: tracheobionta links: self: "/api/v1/subkingdoms/tracheobionta" kingdom: "/api/v1/kingdoms/plantae" kingdom: id: 1 name: Plantae slug: plantae links: self: "/api/v1/kingdoms/plantae" - id: 4 name: Liliopsida slug: liliopsida links: self: "/api/v1/division_classes/liliopsida" division: "/api/v1/divisions/magnoliophyta" division: id: 1 name: Magnoliophyta slug: magnoliophyta links: self: "/api/v1/divisions/magnoliophyta" subkingdom: "/api/v1/subkingdoms/tracheobionta" subkingdom: id: 1 name: Tracheobionta slug: tracheobionta links: self: "/api/v1/subkingdoms/tracheobionta" kingdom: "/api/v1/kingdoms/plantae" kingdom: id: 1 name: Plantae slug: plantae links: self: "/api/v1/kingdoms/plantae" - id: 8 name: Filicopsida slug: filicopsida links: self: "/api/v1/division_classes/filicopsida" division: "/api/v1/divisions/pteridophyta" division: id: 3 name: Pteridophyta slug: pteridophyta links: self: "/api/v1/divisions/pteridophyta" subkingdom: "/api/v1/subkingdoms/tracheobionta" subkingdom: id: 1 name: Tracheobionta slug: tracheobionta links: self: "/api/v1/subkingdoms/tracheobionta" kingdom: "/api/v1/kingdoms/plantae" kingdom: id: 1 name: Plantae slug: plantae links: self: "/api/v1/kingdoms/plantae" - id: 14 name: Cycadopsida slug: cycadopsida links: self: "/api/v1/division_classes/cycadopsida" division: "/api/v1/divisions/cycadophyta" division: id: 4 name: Cycadophyta slug: cycadophyta links: self: "/api/v1/divisions/cycadophyta" subkingdom: "/api/v1/subkingdoms/tracheobionta" subkingdom: id: 1 name: Tracheobionta slug: tracheobionta links: self: "/api/v1/subkingdoms/tracheobionta" kingdom: "/api/v1/kingdoms/plantae" kingdom: id: 1 name: Plantae slug: plantae links: self: "/api/v1/kingdoms/plantae" - id: 16 name: Gnetopsida slug: gnetopsida links: self: "/api/v1/division_classes/gnetopsida" division: "/api/v1/divisions/gnetophyta" division: id: 5 name: Gnetophyta slug: gnetophyta links: self: "/api/v1/divisions/gnetophyta" subkingdom: "/api/v1/subkingdoms/tracheobionta" subkingdom: id: 1 name: Tracheobionta slug: tracheobionta links: self: "/api/v1/subkingdoms/tracheobionta" kingdom: "/api/v1/kingdoms/plantae" kingdom: id: 1 name: Plantae slug: plantae links: self: "/api/v1/kingdoms/plantae" - id: 17 name: Equisetopsida slug: equisetopsida links: self: "/api/v1/division_classes/equisetopsida" division: "/api/v1/divisions/equisetophyta" division: id: 6 name: Equisetophyta slug: equisetophyta links: self: "/api/v1/divisions/equisetophyta" subkingdom: "/api/v1/subkingdoms/tracheobionta" subkingdom: id: 1 name: Tracheobionta slug: tracheobionta links: self: "/api/v1/subkingdoms/tracheobionta" kingdom: "/api/v1/kingdoms/plantae" kingdom: id: 1 name: Plantae slug: plantae links: self: "/api/v1/kingdoms/plantae" - id: 18 name: Ginkgoopsida slug: ginkgoopsida links: self: "/api/v1/division_classes/ginkgoopsida" division: "/api/v1/divisions/ginkgophyta" division: id: 7 name: Ginkgophyta slug: ginkgophyta links: self: "/api/v1/divisions/ginkgophyta" subkingdom: "/api/v1/subkingdoms/tracheobionta" subkingdom: id: 1 name: Tracheobionta slug: tracheobionta links: self: "/api/v1/subkingdoms/tracheobionta" kingdom: "/api/v1/kingdoms/plantae" kingdom: id: 1 name: Plantae slug: plantae links: self: "/api/v1/kingdoms/plantae" - id: 20 name: Lycopodiopsida slug: lycopodiopsida links: self: "/api/v1/division_classes/lycopodiopsida" division: "/api/v1/divisions/lycopodiophyta" division: id: 8 name: Lycopodiophyta slug: lycopodiophyta links: self: "/api/v1/divisions/lycopodiophyta" subkingdom: "/api/v1/subkingdoms/tracheobionta" subkingdom: id: 1 name: Tracheobionta slug: tracheobionta links: self: "/api/v1/subkingdoms/tracheobionta" kingdom: "/api/v1/kingdoms/plantae" kingdom: id: 1 name: Plantae slug: plantae links: self: "/api/v1/kingdoms/plantae" - id: 21 name: Psilopsida slug: psilopsida links: self: "/api/v1/division_classes/psilopsida" division: "/api/v1/divisions/psilophyta" division: id: 9 name: Psilophyta slug: psilophyta links: self: "/api/v1/divisions/psilophyta" subkingdom: "/api/v1/subkingdoms/tracheobionta" subkingdom: id: 1 name: Tracheobionta slug: tracheobionta links: self: "/api/v1/subkingdoms/tracheobionta" kingdom: "/api/v1/kingdoms/plantae" kingdom: id: 1 name: Plantae slug: plantae links: self: "/api/v1/kingdoms/plantae" links: self: "/api/v1/division_classes" first: "/api/v1/division_classes?page=1" last: "/api/v1/division_classes?page=1" meta: total: 10 '401': description: Invalid credentials content: application/json: examples: returns-a-401-response: value: error: true messages: Invalid access token "/api/v1/division_classes/{id}": get: summary: Retrieve a division class tags: - DivisionClasses description: Get a division class operationId: getDivisionClass parameters: - name: id required: true in: path description: The id or the slug of the requested division class schema: type: string security: - token: [] responses: '200': description: Success content: application/json: schema: type: object properties: data: "$ref": "#/components/schemas/division_class" meta: type: object properties: last_modified: type: string examples: returns-a-200-response: value: data: id: 1 name: Magnoliopsida slug: magnoliopsida links: self: "/api/v1/division_classes/magnoliopsida" division: "/api/v1/divisions/magnoliophyta" division: id: 1 name: Magnoliophyta slug: magnoliophyta links: self: "/api/v1/divisions/magnoliophyta" subkingdom: "/api/v1/subkingdoms/tracheobionta" subkingdom: id: 1 name: Tracheobionta slug: tracheobionta links: self: "/api/v1/subkingdoms/tracheobionta" kingdom: "/api/v1/kingdoms/plantae" kingdom: id: 1 name: Plantae slug: plantae links: self: "/api/v1/kingdoms/plantae" meta: last_modified: '2020-07-22T11:16:26.185Z' '401': description: Invalid credentials content: application/json: examples: returns-a-401-response: value: error: true messages: Invalid access token "/api/v1/division_orders": get: summary: Searches division orders tags: - DivisionOrders description: List division orders operationId: listDivisionOrders security: - token: [] parameters: - name: page in: query required: false description: The page to fetch schema: type: number responses: '200': description: Success content: application/json: schema: type: object properties: data: type: array items: "$ref": "#/components/schemas/division_order" links: type: object properties: self: type: string description: A link to the current page of the collection first: type: string description: A link to the first page of the collection next: type: string description: A link to the next page of the collection prev: type: string description: A link to the previous page of the collection last: type: string description: A link to the last page of the collection required: - self meta: type: object properties: total: type: integer examples: returns-a-200-response: value: data: - id: 1 name: Dipsacales slug: dipsacales links: self: "/api/v1/division_orders/dipsacales" division_class: "/api/v1/division_classes/magnoliopsida" division_class: id: 1 name: Magnoliopsida slug: magnoliopsida links: self: "/api/v1/division_classes/magnoliopsida" division: "/api/v1/divisions/magnoliophyta" division: id: 1 name: Magnoliophyta slug: magnoliophyta links: self: "/api/v1/divisions/magnoliophyta" subkingdom: "/api/v1/subkingdoms/tracheobionta" subkingdom: id: 1 name: Tracheobionta slug: tracheobionta links: self: "/api/v1/subkingdoms/tracheobionta" kingdom: "/api/v1/kingdoms/plantae" kingdom: id: 1 name: Plantae slug: plantae links: self: "/api/v1/kingdoms/plantae" - id: 2 name: Malvales slug: malvales links: self: "/api/v1/division_orders/malvales" division_class: "/api/v1/division_classes/magnoliopsida" division_class: id: 1 name: Magnoliopsida slug: magnoliopsida links: self: "/api/v1/division_classes/magnoliopsida" division: "/api/v1/divisions/magnoliophyta" division: id: 1 name: Magnoliophyta slug: magnoliophyta links: self: "/api/v1/divisions/magnoliophyta" subkingdom: "/api/v1/subkingdoms/tracheobionta" subkingdom: id: 1 name: Tracheobionta slug: tracheobionta links: self: "/api/v1/subkingdoms/tracheobionta" kingdom: "/api/v1/kingdoms/plantae" kingdom: id: 1 name: Plantae slug: plantae links: self: "/api/v1/kingdoms/plantae" - id: 3 name: Pinales slug: pinales links: self: "/api/v1/division_orders/pinales" division_class: "/api/v1/division_classes/pinopsida" division_class: id: 2 name: Pinopsida slug: pinopsida links: self: "/api/v1/division_classes/pinopsida" division: "/api/v1/divisions/coniferophyta" division: id: 2 name: Coniferophyta slug: coniferophyta links: self: "/api/v1/divisions/coniferophyta" subkingdom: "/api/v1/subkingdoms/tracheobionta" subkingdom: id: 1 name: Tracheobionta slug: tracheobionta links: self: "/api/v1/subkingdoms/tracheobionta" kingdom: "/api/v1/kingdoms/plantae" kingdom: id: 1 name: Plantae slug: plantae links: self: "/api/v1/kingdoms/plantae" - id: 5 name: Cyperales slug: cyperales links: self: "/api/v1/division_orders/cyperales" division_class: "/api/v1/division_classes/liliopsida" division_class: id: 4 name: Liliopsida slug: liliopsida links: self: "/api/v1/division_classes/liliopsida" division: "/api/v1/divisions/magnoliophyta" division: id: 1 name: Magnoliophyta slug: magnoliophyta links: self: "/api/v1/divisions/magnoliophyta" subkingdom: "/api/v1/subkingdoms/tracheobionta" subkingdom: id: 1 name: Tracheobionta slug: tracheobionta links: self: "/api/v1/subkingdoms/tracheobionta" kingdom: "/api/v1/kingdoms/plantae" kingdom: id: 1 name: Plantae slug: plantae links: self: "/api/v1/kingdoms/plantae" - id: 6 name: Caryophyllales slug: caryophyllales links: self: "/api/v1/division_orders/caryophyllales" division_class: "/api/v1/division_classes/magnoliopsida" division_class: id: 1 name: Magnoliopsida slug: magnoliopsida links: self: "/api/v1/division_classes/magnoliopsida" division: "/api/v1/divisions/magnoliophyta" division: id: 1 name: Magnoliophyta slug: magnoliophyta links: self: "/api/v1/divisions/magnoliophyta" subkingdom: "/api/v1/subkingdoms/tracheobionta" subkingdom: id: 1 name: Tracheobionta slug: tracheobionta links: self: "/api/v1/subkingdoms/tracheobionta" kingdom: "/api/v1/kingdoms/plantae" kingdom: id: 1 name: Plantae slug: plantae links: self: "/api/v1/kingdoms/plantae" - id: 8 name: Fabales slug: fabales links: self: "/api/v1/division_orders/fabales" division_class: "/api/v1/division_classes/magnoliopsida" division_class: id: 1 name: Magnoliopsida slug: magnoliopsida links: self: "/api/v1/division_classes/magnoliopsida" division: "/api/v1/divisions/magnoliophyta" division: id: 1 name: Magnoliophyta slug: magnoliophyta links: self: "/api/v1/divisions/magnoliophyta" subkingdom: "/api/v1/subkingdoms/tracheobionta" subkingdom: id: 1 name: Tracheobionta slug: tracheobionta links: self: "/api/v1/subkingdoms/tracheobionta" kingdom: "/api/v1/kingdoms/plantae" kingdom: id: 1 name: Plantae slug: plantae links: self: "/api/v1/kingdoms/plantae" - id: 10 name: Rosales slug: rosales links: self: "/api/v1/division_orders/rosales" division_class: "/api/v1/division_classes/magnoliopsida" division_class: id: 1 name: Magnoliopsida slug: magnoliopsida links: self: "/api/v1/division_classes/magnoliopsida" division: "/api/v1/divisions/magnoliophyta" division: id: 1 name: Magnoliophyta slug: magnoliophyta links: self: "/api/v1/divisions/magnoliophyta" subkingdom: "/api/v1/subkingdoms/tracheobionta" subkingdom: id: 1 name: Tracheobionta slug: tracheobionta links: self: "/api/v1/subkingdoms/tracheobionta" kingdom: "/api/v1/kingdoms/plantae" kingdom: id: 1 name: Plantae slug: plantae links: self: "/api/v1/kingdoms/plantae" - id: 11 name: Euphorbiales slug: euphorbiales links: self: "/api/v1/division_orders/euphorbiales" division_class: "/api/v1/division_classes/magnoliopsida" division_class: id: 1 name: Magnoliopsida slug: magnoliopsida links: self: "/api/v1/division_classes/magnoliopsida" division: "/api/v1/divisions/magnoliophyta" division: id: 1 name: Magnoliophyta slug: magnoliophyta links: self: "/api/v1/divisions/magnoliophyta" subkingdom: "/api/v1/subkingdoms/tracheobionta" subkingdom: id: 1 name: Tracheobionta slug: tracheobionta links: self: "/api/v1/subkingdoms/tracheobionta" kingdom: "/api/v1/kingdoms/plantae" kingdom: id: 1 name: Plantae slug: plantae links: self: "/api/v1/kingdoms/plantae" - id: 12 name: Asterales slug: asterales links: self: "/api/v1/division_orders/asterales" division_class: "/api/v1/division_classes/magnoliopsida" division_class: id: 1 name: Magnoliopsida slug: magnoliopsida links: self: "/api/v1/division_classes/magnoliopsida" division: "/api/v1/divisions/magnoliophyta" division: id: 1 name: Magnoliophyta slug: magnoliophyta links: self: "/api/v1/divisions/magnoliophyta" subkingdom: "/api/v1/subkingdoms/tracheobionta" subkingdom: id: 1 name: Tracheobionta slug: tracheobionta links: self: "/api/v1/subkingdoms/tracheobionta" kingdom: "/api/v1/kingdoms/plantae" kingdom: id: 1 name: Plantae slug: plantae links: self: "/api/v1/kingdoms/plantae" - id: 13 name: Lamiales slug: lamiales links: self: "/api/v1/division_orders/lamiales" division_class: "/api/v1/division_classes/magnoliopsida" division_class: id: 1 name: Magnoliopsida slug: magnoliopsida links: self: "/api/v1/division_classes/magnoliopsida" division: "/api/v1/divisions/magnoliophyta" division: id: 1 name: Magnoliophyta slug: magnoliophyta links: self: "/api/v1/divisions/magnoliophyta" subkingdom: "/api/v1/subkingdoms/tracheobionta" subkingdom: id: 1 name: Tracheobionta slug: tracheobionta links: self: "/api/v1/subkingdoms/tracheobionta" kingdom: "/api/v1/kingdoms/plantae" kingdom: id: 1 name: Plantae slug: plantae links: self: "/api/v1/kingdoms/plantae" - id: 14 name: Scrophulariales slug: scrophulariales links: self: "/api/v1/division_orders/scrophulariales" division_class: "/api/v1/division_classes/magnoliopsida" division_class: id: 1 name: Magnoliopsida slug: magnoliopsida links: self: "/api/v1/division_classes/magnoliopsida" division: "/api/v1/divisions/magnoliophyta" division: id: 1 name: Magnoliophyta slug: magnoliophyta links: self: "/api/v1/divisions/magnoliophyta" subkingdom: "/api/v1/subkingdoms/tracheobionta" subkingdom: id: 1 name: Tracheobionta slug: tracheobionta links: self: "/api/v1/subkingdoms/tracheobionta" kingdom: "/api/v1/kingdoms/plantae" kingdom: id: 1 name: Plantae slug: plantae links: self: "/api/v1/kingdoms/plantae" - id: 17 name: Sapindales slug: sapindales links: self: "/api/v1/division_orders/sapindales" division_class: "/api/v1/division_classes/magnoliopsida" division_class: id: 1 name: Magnoliopsida slug: magnoliopsida links: self: "/api/v1/division_classes/magnoliopsida" division: "/api/v1/divisions/magnoliophyta" division: id: 1 name: Magnoliophyta slug: magnoliophyta links: self: "/api/v1/divisions/magnoliophyta" subkingdom: "/api/v1/subkingdoms/tracheobionta" subkingdom: id: 1 name: Tracheobionta slug: tracheobionta links: self: "/api/v1/subkingdoms/tracheobionta" kingdom: "/api/v1/kingdoms/plantae" kingdom: id: 1 name: Plantae slug: plantae links: self: "/api/v1/kingdoms/plantae" - id: 18 name: Ranunculales slug: ranunculales links: self: "/api/v1/division_orders/ranunculales" division_class: "/api/v1/division_classes/magnoliopsida" division_class: id: 1 name: Magnoliopsida slug: magnoliopsida links: self: "/api/v1/division_classes/magnoliopsida" division: "/api/v1/divisions/magnoliophyta" division: id: 1 name: Magnoliophyta slug: magnoliophyta links: self: "/api/v1/divisions/magnoliophyta" subkingdom: "/api/v1/subkingdoms/tracheobionta" subkingdom: id: 1 name: Tracheobionta slug: tracheobionta links: self: "/api/v1/subkingdoms/tracheobionta" kingdom: "/api/v1/kingdoms/plantae" kingdom: id: 1 name: Plantae slug: plantae links: self: "/api/v1/kingdoms/plantae" - id: 19 name: Calycerales slug: calycerales links: self: "/api/v1/division_orders/calycerales" division_class: "/api/v1/division_classes/magnoliopsida" division_class: id: 1 name: Magnoliopsida slug: magnoliopsida links: self: "/api/v1/division_classes/magnoliopsida" division: "/api/v1/divisions/magnoliophyta" division: id: 1 name: Magnoliophyta slug: magnoliophyta links: self: "/api/v1/divisions/magnoliophyta" subkingdom: "/api/v1/subkingdoms/tracheobionta" subkingdom: id: 1 name: Tracheobionta slug: tracheobionta links: self: "/api/v1/subkingdoms/tracheobionta" kingdom: "/api/v1/kingdoms/plantae" kingdom: id: 1 name: Plantae slug: plantae links: self: "/api/v1/kingdoms/plantae" - id: 20 name: Liliales slug: liliales links: self: "/api/v1/division_orders/liliales" division_class: "/api/v1/division_classes/liliopsida" division_class: id: 4 name: Liliopsida slug: liliopsida links: self: "/api/v1/division_classes/liliopsida" division: "/api/v1/divisions/magnoliophyta" division: id: 1 name: Magnoliophyta slug: magnoliophyta links: self: "/api/v1/divisions/magnoliophyta" subkingdom: "/api/v1/subkingdoms/tracheobionta" subkingdom: id: 1 name: Tracheobionta slug: tracheobionta links: self: "/api/v1/subkingdoms/tracheobionta" kingdom: "/api/v1/kingdoms/plantae" kingdom: id: 1 name: Plantae slug: plantae links: self: "/api/v1/kingdoms/plantae" - id: 21 name: Apiales slug: apiales links: self: "/api/v1/division_orders/apiales" division_class: "/api/v1/division_classes/magnoliopsida" division_class: id: 1 name: Magnoliopsida slug: magnoliopsida links: self: "/api/v1/division_classes/magnoliopsida" division: "/api/v1/divisions/magnoliophyta" division: id: 1 name: Magnoliophyta slug: magnoliophyta links: self: "/api/v1/divisions/magnoliophyta" subkingdom: "/api/v1/subkingdoms/tracheobionta" subkingdom: id: 1 name: Tracheobionta slug: tracheobionta links: self: "/api/v1/subkingdoms/tracheobionta" kingdom: "/api/v1/kingdoms/plantae" kingdom: id: 1 name: Plantae slug: plantae links: self: "/api/v1/kingdoms/plantae" - id: 22 name: Myrtales slug: myrtales links: self: "/api/v1/division_orders/myrtales" division_class: "/api/v1/division_classes/magnoliopsida" division_class: id: 1 name: Magnoliopsida slug: magnoliopsida links: self: "/api/v1/division_classes/magnoliopsida" division: "/api/v1/divisions/magnoliophyta" division: id: 1 name: Magnoliophyta slug: magnoliophyta links: self: "/api/v1/divisions/magnoliophyta" subkingdom: "/api/v1/subkingdoms/tracheobionta" subkingdom: id: 1 name: Tracheobionta slug: tracheobionta links: self: "/api/v1/subkingdoms/tracheobionta" kingdom: "/api/v1/kingdoms/plantae" kingdom: id: 1 name: Plantae slug: plantae links: self: "/api/v1/kingdoms/plantae" - id: 23 name: Solanales slug: solanales links: self: "/api/v1/division_orders/solanales" division_class: "/api/v1/division_classes/magnoliopsida" division_class: id: 1 name: Magnoliopsida slug: magnoliopsida links: self: "/api/v1/division_classes/magnoliopsida" division: "/api/v1/divisions/magnoliophyta" division: id: 1 name: Magnoliophyta slug: magnoliophyta links: self: "/api/v1/divisions/magnoliophyta" subkingdom: "/api/v1/subkingdoms/tracheobionta" subkingdom: id: 1 name: Tracheobionta slug: tracheobionta links: self: "/api/v1/subkingdoms/tracheobionta" kingdom: "/api/v1/kingdoms/plantae" kingdom: id: 1 name: Plantae slug: plantae links: self: "/api/v1/kingdoms/plantae" - id: 24 name: Arecales slug: arecales links: self: "/api/v1/division_orders/arecales" division_class: "/api/v1/division_classes/liliopsida" division_class: id: 4 name: Liliopsida slug: liliopsida links: self: "/api/v1/division_classes/liliopsida" division: "/api/v1/divisions/magnoliophyta" division: id: 1 name: Magnoliophyta slug: magnoliophyta links: self: "/api/v1/divisions/magnoliophyta" subkingdom: "/api/v1/subkingdoms/tracheobionta" subkingdom: id: 1 name: Tracheobionta slug: tracheobionta links: self: "/api/v1/subkingdoms/tracheobionta" kingdom: "/api/v1/kingdoms/plantae" kingdom: id: 1 name: Plantae slug: plantae links: self: "/api/v1/kingdoms/plantae" - id: 25 name: Arales slug: arales links: self: "/api/v1/division_orders/arales" division_class: "/api/v1/division_classes/liliopsida" division_class: id: 4 name: Liliopsida slug: liliopsida links: self: "/api/v1/division_classes/liliopsida" division: "/api/v1/divisions/magnoliophyta" division: id: 1 name: Magnoliophyta slug: magnoliophyta links: self: "/api/v1/divisions/magnoliophyta" subkingdom: "/api/v1/subkingdoms/tracheobionta" subkingdom: id: 1 name: Tracheobionta slug: tracheobionta links: self: "/api/v1/subkingdoms/tracheobionta" kingdom: "/api/v1/kingdoms/plantae" kingdom: id: 1 name: Plantae slug: plantae links: self: "/api/v1/kingdoms/plantae" links: self: "/api/v1/division_orders" first: "/api/v1/division_orders?page=1" next: "/api/v1/division_orders?page=2" last: "/api/v1/division_orders?page=5" meta: total: 93 '401': description: Invalid credentials content: application/json: examples: returns-a-401-response: value: error: true messages: Invalid access token "/api/v1/division_orders/{id}": get: summary: Retrieve a division order tags: - DivisionOrders description: Get a division order operationId: getDivisionOrder parameters: - name: id required: true in: path description: The id or the slug of the requested division order schema: type: string security: - token: [] responses: '200': description: Success content: application/json: schema: type: object properties: data: "$ref": "#/components/schemas/division_order" meta: type: object properties: last_modified: type: string examples: returns-a-200-response: value: data: id: 1 name: Dipsacales slug: dipsacales links: self: "/api/v1/division_orders/dipsacales" division_class: "/api/v1/division_classes/magnoliopsida" division_class: id: 1 name: Magnoliopsida slug: magnoliopsida links: self: "/api/v1/division_classes/magnoliopsida" division: "/api/v1/divisions/magnoliophyta" division: id: 1 name: Magnoliophyta slug: magnoliophyta links: self: "/api/v1/divisions/magnoliophyta" subkingdom: "/api/v1/subkingdoms/tracheobionta" subkingdom: id: 1 name: Tracheobionta slug: tracheobionta links: self: "/api/v1/subkingdoms/tracheobionta" kingdom: "/api/v1/kingdoms/plantae" kingdom: id: 1 name: Plantae slug: plantae links: self: "/api/v1/kingdoms/plantae" meta: last_modified: '2020-07-22T11:16:26.221Z' '401': description: Invalid credentials content: application/json: examples: returns-a-401-response: value: error: true messages: Invalid access token "/api/v1/families": get: summary: Searches families tags: - Families description: List families operationId: listFamilies security: - token: [] parameters: - name: page in: query required: false description: The page to fetch schema: type: number - name: filter in: query required: false type: object description: Filter on values schema: "$ref": "#/components/schemas/filters_families" - name: order in: query required: false type: object description: Sort on values schema: "$ref": "#/components/schemas/sorts_families" responses: '200': description: Success content: application/json: schema: type: object properties: data: type: array items: "$ref": "#/components/schemas/family" links: type: object properties: self: type: string description: A link to the current page of the collection first: type: string description: A link to the first page of the collection next: type: string description: A link to the next page of the collection prev: type: string description: A link to the previous page of the collection last: type: string description: A link to the last page of the collection required: - self meta: type: object properties: total: type: integer examples: returns-a-200-response: value: data: - id: 22 name: Amaranthaceae common_name: Amaranth family slug: amaranthaceae links: self: "/api/v1/families/amaranthaceae" division_order: "/api/v1/division_orders/caryophyllales" genus: "/api/v1/families/amaranthaceae/genus" division_order: id: 6 name: Caryophyllales slug: caryophyllales links: self: "/api/v1/division_orders/caryophyllales" division_class: "/api/v1/division_classes/magnoliopsida" division_class: id: 1 name: Magnoliopsida slug: magnoliopsida links: self: "/api/v1/division_classes/magnoliopsida" division: "/api/v1/divisions/magnoliophyta" division: id: 1 name: Magnoliophyta slug: magnoliophyta links: self: "/api/v1/divisions/magnoliophyta" subkingdom: "/api/v1/subkingdoms/tracheobionta" subkingdom: id: 1 name: Tracheobionta slug: tracheobionta links: self: "/api/v1/subkingdoms/tracheobionta" kingdom: "/api/v1/kingdoms/plantae" kingdom: id: 1 name: Plantae slug: plantae links: self: "/api/v1/kingdoms/plantae" - id: 13 name: Asteraceae common_name: Aster family slug: asteraceae links: self: "/api/v1/families/asteraceae" division_order: "/api/v1/division_orders/asterales" genus: "/api/v1/families/asteraceae/genus" division_order: id: 12 name: Asterales slug: asterales links: self: "/api/v1/division_orders/asterales" division_class: "/api/v1/division_classes/magnoliopsida" division_class: id: 1 name: Magnoliopsida slug: magnoliopsida links: self: "/api/v1/division_classes/magnoliopsida" division: "/api/v1/divisions/magnoliophyta" division: id: 1 name: Magnoliophyta slug: magnoliophyta links: self: "/api/v1/divisions/magnoliophyta" subkingdom: "/api/v1/subkingdoms/tracheobionta" subkingdom: id: 1 name: Tracheobionta slug: tracheobionta links: self: "/api/v1/subkingdoms/tracheobionta" kingdom: "/api/v1/kingdoms/plantae" kingdom: id: 1 name: Plantae slug: plantae links: self: "/api/v1/kingdoms/plantae" - id: 51 name: Bromeliaceae common_name: Bromeliad family slug: bromeliaceae links: self: "/api/v1/families/bromeliaceae" division_order: "/api/v1/division_orders/bromeliales" genus: "/api/v1/families/bromeliaceae/genus" division_order: id: 36 name: Bromeliales slug: bromeliales links: self: "/api/v1/division_orders/bromeliales" division_class: "/api/v1/division_classes/liliopsida" division_class: id: 4 name: Liliopsida slug: liliopsida links: self: "/api/v1/division_classes/liliopsida" division: "/api/v1/divisions/magnoliophyta" division: id: 1 name: Magnoliophyta slug: magnoliophyta links: self: "/api/v1/divisions/magnoliophyta" subkingdom: "/api/v1/subkingdoms/tracheobionta" subkingdom: id: 1 name: Tracheobionta slug: tracheobionta links: self: "/api/v1/subkingdoms/tracheobionta" kingdom: "/api/v1/kingdoms/plantae" kingdom: id: 1 name: Plantae slug: plantae links: self: "/api/v1/kingdoms/plantae" - id: 1 name: Caprifoliaceae common_name: Honeysuckle family slug: caprifoliaceae links: self: "/api/v1/families/caprifoliaceae" division_order: "/api/v1/division_orders/dipsacales" genus: "/api/v1/families/caprifoliaceae/genus" division_order: id: 1 name: Dipsacales slug: dipsacales links: self: "/api/v1/division_orders/dipsacales" division_class: "/api/v1/division_classes/magnoliopsida" division_class: id: 1 name: Magnoliopsida slug: magnoliopsida links: self: "/api/v1/division_classes/magnoliopsida" division: "/api/v1/divisions/magnoliophyta" division: id: 1 name: Magnoliophyta slug: magnoliophyta links: self: "/api/v1/divisions/magnoliophyta" subkingdom: "/api/v1/subkingdoms/tracheobionta" subkingdom: id: 1 name: Tracheobionta slug: tracheobionta links: self: "/api/v1/subkingdoms/tracheobionta" kingdom: "/api/v1/kingdoms/plantae" kingdom: id: 1 name: Plantae slug: plantae links: self: "/api/v1/kingdoms/plantae" - id: 60 name: Ericaceae common_name: Heath family slug: ericaceae links: self: "/api/v1/families/ericaceae" division_order: "/api/v1/division_orders/ericales" genus: "/api/v1/families/ericaceae/genus" division_order: id: 39 name: Ericales slug: ericales links: self: "/api/v1/division_orders/ericales" division_class: "/api/v1/division_classes/magnoliopsida" division_class: id: 1 name: Magnoliopsida slug: magnoliopsida links: self: "/api/v1/division_classes/magnoliopsida" division: "/api/v1/divisions/magnoliophyta" division: id: 1 name: Magnoliophyta slug: magnoliophyta links: self: "/api/v1/divisions/magnoliophyta" subkingdom: "/api/v1/subkingdoms/tracheobionta" subkingdom: id: 1 name: Tracheobionta slug: tracheobionta links: self: "/api/v1/subkingdoms/tracheobionta" kingdom: "/api/v1/kingdoms/plantae" kingdom: id: 1 name: Plantae slug: plantae links: self: "/api/v1/kingdoms/plantae" - id: 339 name: Grossulariaceae common_name: Currant family slug: grossulariaceae links: self: "/api/v1/families/grossulariaceae" division_order: "/api/v1/division_orders/rosales" genus: "/api/v1/families/grossulariaceae/genus" division_order: id: 10 name: Rosales slug: rosales links: self: "/api/v1/division_orders/rosales" division_class: "/api/v1/division_classes/magnoliopsida" division_class: id: 1 name: Magnoliopsida slug: magnoliopsida links: self: "/api/v1/division_classes/magnoliopsida" division: "/api/v1/divisions/magnoliophyta" division: id: 1 name: Magnoliophyta slug: magnoliophyta links: self: "/api/v1/divisions/magnoliophyta" subkingdom: "/api/v1/subkingdoms/tracheobionta" subkingdom: id: 1 name: Tracheobionta slug: tracheobionta links: self: "/api/v1/subkingdoms/tracheobionta" kingdom: "/api/v1/kingdoms/plantae" kingdom: id: 1 name: Plantae slug: plantae links: self: "/api/v1/kingdoms/plantae" - id: 3 name: Pinaceae common_name: Pine family slug: pinaceae links: self: "/api/v1/families/pinaceae" division_order: "/api/v1/division_orders/pinales" genus: "/api/v1/families/pinaceae/genus" division_order: id: 3 name: Pinales slug: pinales links: self: "/api/v1/division_orders/pinales" division_class: "/api/v1/division_classes/pinopsida" division_class: id: 2 name: Pinopsida slug: pinopsida links: self: "/api/v1/division_classes/pinopsida" division: "/api/v1/divisions/coniferophyta" division: id: 2 name: Coniferophyta slug: coniferophyta links: self: "/api/v1/divisions/coniferophyta" subkingdom: "/api/v1/subkingdoms/tracheobionta" subkingdom: id: 1 name: Tracheobionta slug: tracheobionta links: self: "/api/v1/subkingdoms/tracheobionta" kingdom: "/api/v1/kingdoms/plantae" kingdom: id: 1 name: Plantae slug: plantae links: self: "/api/v1/kingdoms/plantae" links: self: "/api/v1/families" first: "/api/v1/families?page=1" last: "/api/v1/families?page=1" meta: total: 7 '401': description: Invalid credentials content: application/json: examples: returns-a-401-response: value: error: true messages: Invalid access token "/api/v1/families/{id}": get: summary: Retrieve a family tags: - Families description: Get a family operationId: getFamily parameters: - name: id required: true in: path description: The id or the slug of the requested family schema: type: string security: - token: [] responses: '200': description: Success content: application/json: schema: type: object properties: data: "$ref": "#/components/schemas/family" meta: type: object properties: last_modified: type: string examples: returns-a-200-response: value: data: id: 1 name: Caprifoliaceae common_name: Honeysuckle family slug: caprifoliaceae links: self: "/api/v1/families/caprifoliaceae" division_order: "/api/v1/division_orders/dipsacales" genus: "/api/v1/families/caprifoliaceae/genus" division_order: id: 1 name: Dipsacales slug: dipsacales links: self: "/api/v1/division_orders/dipsacales" division_class: "/api/v1/division_classes/magnoliopsida" division_class: id: 1 name: Magnoliopsida slug: magnoliopsida links: self: "/api/v1/division_classes/magnoliopsida" division: "/api/v1/divisions/magnoliophyta" division: id: 1 name: Magnoliophyta slug: magnoliophyta links: self: "/api/v1/divisions/magnoliophyta" subkingdom: "/api/v1/subkingdoms/tracheobionta" subkingdom: id: 1 name: Tracheobionta slug: tracheobionta links: self: "/api/v1/subkingdoms/tracheobionta" kingdom: "/api/v1/kingdoms/plantae" kingdom: id: 1 name: Plantae slug: plantae links: self: "/api/v1/kingdoms/plantae" meta: last_modified: '2020-07-22T11:16:26.465Z' '401': description: Invalid credentials content: application/json: examples: returns-a-401-response: value: error: true messages: Invalid access token "/api/v1/genus": get: summary: Searches genus tags: - Genus description: List genus operationId: listGenus parameters: - name: filter in: query required: false type: object description: Filter on values schema: "$ref": "#/components/schemas/filters_genus" - name: order in: query required: false type: object description: Sort on values schema: "$ref": "#/components/schemas/sorts_genus" - name: page in: query required: false description: The page to fetch schema: type: number security: - token: [] responses: '200': description: Success content: application/json: schema: type: object properties: data: type: array items: "$ref": "#/components/schemas/genus" links: type: object properties: self: type: string description: A link to the current page of the collection first: type: string description: A link to the first page of the collection next: type: string description: A link to the next page of the collection prev: type: string description: A link to the previous page of the collection last: type: string description: A link to the last page of the collection required: - self meta: type: object properties: total: type: integer examples: returns-a-200-response: value: data: - id: 4 name: Abies slug: abies links: self: "/api/v1/genus/abies" plants: "/api/v1/genus/abies/plants" species: "/api/v1/genus/abies/species" family: "/api/v1/families/pinaceae" family: id: 3 name: Pinaceae common_name: Pine family slug: pinaceae links: self: "/api/v1/families/pinaceae" division_order: "/api/v1/division_orders/pinales" genus: "/api/v1/families/pinaceae/genus" - id: 599 name: Arctostaphylos slug: arctostaphylos links: self: "/api/v1/genus/arctostaphylos" plants: "/api/v1/genus/arctostaphylos/plants" species: "/api/v1/genus/arctostaphylos/species" family: "/api/v1/families/ericaceae" family: id: 60 name: Ericaceae common_name: Heath family slug: ericaceae links: self: "/api/v1/families/ericaceae" division_order: "/api/v1/division_orders/ericales" genus: "/api/v1/families/ericaceae/genus" - id: 272 name: Aster slug: aster links: self: "/api/v1/genus/aster" plants: "/api/v1/genus/aster/plants" species: "/api/v1/genus/aster/species" family: "/api/v1/families/asteraceae" family: id: 13 name: Asteraceae common_name: Aster family slug: asteraceae links: self: "/api/v1/families/asteraceae" division_order: "/api/v1/division_orders/asterales" genus: "/api/v1/families/asteraceae/genus" - id: 1700 name: Lonicera slug: lonicera links: self: "/api/v1/genus/lonicera" plants: "/api/v1/genus/lonicera/plants" species: "/api/v1/genus/lonicera/species" family: "/api/v1/families/caprifoliaceae" family: id: 1 name: Caprifoliaceae common_name: Honeysuckle family slug: caprifoliaceae links: self: "/api/v1/families/caprifoliaceae" division_order: "/api/v1/division_orders/dipsacales" genus: "/api/v1/families/caprifoliaceae/genus" - id: 4407 name: Maireana slug: maireana links: self: "/api/v1/genus/maireana" plants: "/api/v1/genus/maireana/plants" species: "/api/v1/genus/maireana/species" family: "/api/v1/families/amaranthaceae" family: id: 22 name: Amaranthaceae common_name: Amaranth family slug: amaranthaceae links: self: "/api/v1/families/amaranthaceae" division_order: "/api/v1/division_orders/caryophyllales" genus: "/api/v1/families/amaranthaceae/genus" - id: 10052 name: Puya slug: puya links: self: "/api/v1/genus/puya" plants: "/api/v1/genus/puya/plants" species: "/api/v1/genus/puya/species" family: "/api/v1/families/bromeliaceae" family: id: 51 name: Bromeliaceae common_name: Bromeliad family slug: bromeliaceae links: self: "/api/v1/families/bromeliaceae" division_order: "/api/v1/division_orders/bromeliales" genus: "/api/v1/families/bromeliaceae/genus" - id: 5882 name: Ribes slug: ribes links: self: "/api/v1/genus/ribes" plants: "/api/v1/genus/ribes/plants" species: "/api/v1/genus/ribes/species" family: "/api/v1/families/grossulariaceae" family: id: 339 name: Grossulariaceae common_name: Currant family slug: grossulariaceae links: self: "/api/v1/families/grossulariaceae" division_order: "/api/v1/division_orders/rosales" genus: "/api/v1/families/grossulariaceae/genus" links: self: "/api/v1/genus" first: "/api/v1/genus?page=1" last: "/api/v1/genus?page=1" meta: total: 7 '401': description: Invalid credentials content: application/json: examples: returns-a-401-response: value: error: true messages: Invalid access token "/api/v1/genus/{id}": get: summary: Retrieve a genus tags: - Genus description: Get a genus operationId: getGenus parameters: - name: id required: true in: path description: The id or the slug of the requested genus schema: type: string security: - token: [] responses: '200': description: Success content: application/json: schema: type: object properties: data: "$ref": "#/components/schemas/genus" meta: type: object properties: last_modified: type: string examples: returns-a-200-response: value: data: id: 4 name: Abies slug: abies links: self: "/api/v1/genus/abies" plants: "/api/v1/genus/abies/plants" species: "/api/v1/genus/abies/species" family: "/api/v1/families/pinaceae" family: id: 3 name: Pinaceae common_name: Pine family slug: pinaceae links: self: "/api/v1/families/pinaceae" division_order: "/api/v1/division_orders/pinales" genus: "/api/v1/families/pinaceae/genus" meta: last_modified: '2020-07-22T11:16:26.484Z' '401': description: Invalid credentials content: application/json: examples: returns-a-401-response: value: error: true messages: Invalid access token "/api/v1/plants": get: summary: List plants tags: - Plants description: List plants operationId: listPlants security: - token: [] parameters: - name: filter in: query required: false type: object description: Filter on values schema: "$ref": "#/components/schemas/filters_species" - name: filter_not in: query required: false type: object description: Exclude results matching null values schema: "$ref": "#/components/schemas/filters_not_species" - name: order in: query required: false type: object description: Sort on values schema: "$ref": "#/components/schemas/sorts_species" - name: range in: query required: false type: object description: Range on values schema: "$ref": "#/components/schemas/ranges_species" - name: page in: query required: false description: The page to fetch schema: type: number responses: '200': description: Success content: application/json: schema: type: object properties: data: type: array items: "$ref": "#/components/schemas/species_light" links: type: object properties: self: type: string description: A link to the current page of the collection first: type: string description: A link to the first page of the collection next: type: string description: A link to the next page of the collection prev: type: string description: A link to the previous page of the collection last: type: string description: A link to the last page of the collection required: - self meta: type: object properties: total: type: integer examples: returns-a-200-response: value: data: - id: 151545 common_name: dwarf honeysuckle slug: lonicera-xylosteum scientific_name: Lonicera xylosteum year: 1753 bibliography: 'Sp. Pl.: 174 (1753)' author: L. status: accepted rank: species family_common_name: Honeysuckle family genus_id: 1700 image_url: https://bs.floristic.org/image/o/54fb8312373faf0b7a1c7b84979331cc9d7619fc synonyms: - Lonicera dumetorum - Chamaecerasus xylosteum - Lonicera ochroleuca - Xylosteon dumetorum - Caprifolium xylosteum - Caprifolium dumetorum - Chamaecerasus dumetorum - Lonicera rubra - Euchylia villosa genus: Lonicera family: Caprifoliaceae links: self: "/api/v1/species/lonicera-xylosteum" plant: "/api/v1/plants/lonicera-xylosteum" genus: "/api/v1/genus/lonicera" - id: 1164724 common_name: slug: abies-alba scientific_name: Abies alba year: bibliography: author: Mill. status: accepted rank: species family_common_name: genus_id: 4 image_url: synonyms: [] genus: Abies family: Pinaceae links: self: "/api/v1/species/abies-alba" plant: "/api/v1/plants/abies-alba" genus: "/api/v1/genus/abies" - id: 106847 common_name: kinnikinnick slug: arctostaphylos-uva-ursi scientific_name: Arctostaphylos uva-ursi year: 1825 bibliography: 'Syst. Veg. 2: 287 (1825)' author: Spreng. (L.) status: accepted rank: species family_common_name: Heath family genus_id: 599 image_url: https://bs.floristic.org/image/o/aa4f6610a4ebb4eb9a2e22f7853d5d038b048660 synonyms: - Arctostaphylos uva-ursi var. saxicola - Arctostaphylos adenotricha - Arctostaphylos uva-ursi var. adenotricha - Arctostaphylos uva-ursi var. coactilis - Arctostaphylos uva-ursi var. leobreweri - Arctostaphylos uva-ursi var. marinensis - Arctostaphylos uva-ursi var. pacifica - Arctostaphylos uva-ursi var. stipitata - Arctostaphylos uva-ursi var. suborbiculata - Uva-ursi buxifolia - Arctostaphylos uva-ursi subsp. adenotricha - Arctostaphylos uva-ursi subsp. stipitata - Arbutus uva-ursi - Arctostaphylos uva-ursi subsp. monoensis - Uva-ursi uva-ursi var. coactilis - Arctostaphylos procumbens - Uva-ursi procumbens - Arctostaphylos uva-ursi var. fendleriana - Uva-ursi procumbens var. coactilis - Arbutus officinalis - Uva-ursi procumbens var. adenotricha - Arctostaphylos uva-ursi subsp. coactilis - Arbutus buxifolia - Arctostaphylos uva-ursi f. marinensis - Arbutus procumbens - Daphnidostaphylis fendleriana - Arctostaphylos uva-ursi subsp. crassifolius - Arctostaphylos uva-ursi f. coactilis - Arctostaphylos uva-ursi subsp. longipilosa - Arctostaphylos officinalis genus: Arctostaphylos family: Ericaceae links: self: "/api/v1/species/arctostaphylos-uva-ursi" plant: "/api/v1/plants/arctostaphylos-uva-ursi" genus: "/api/v1/genus/arctostaphylos" - id: 315289 common_name: slug: maireana-tomentosa scientific_name: Maireana tomentosa year: 1840 bibliography: Chenop. Monogr. Enum., 96, 96, 1840 author: Moq. status: accepted rank: species family_common_name: genus_id: 4407 image_url: http://d2seqvvyy3b8p2.cloudfront.net/a1d2563c0435af30c49c0db543f4e2b1.jpg synonyms: - Kochia tomentosa var. enchylaenoides - Kochia enchylaenoides genus: Maireana family: Amaranthaceae links: self: "/api/v1/species/maireana-tomentosa" plant: "/api/v1/plants/maireana-tomentosa" genus: "/api/v1/genus/maireana" - id: 292293 common_name: slug: puya-araneosa scientific_name: Puya araneosa year: 1954 bibliography: 'Phytologia 5: 48 (1954)' author: L.B.Sm. status: accepted rank: species family_common_name: Bromeliad family genus_id: 10052 image_url: synonyms: [] genus: Puya family: Bromeliaceae links: self: "/api/v1/species/puya-araneosa" plant: "/api/v1/plants/puya-araneosa" genus: "/api/v1/genus/puya" - id: 697964 common_name: slug: ribes-tenue scientific_name: Ribes tenue year: 1906 bibliography: 'Bull. Int. Acad. Sci. Cracovie, Cl. Sci. Math. 6: 290 (1906)' author: Jancz. status: accepted rank: species family_common_name: genus_id: 5882 image_url: http://d2seqvvyy3b8p2.cloudfront.net/4234eb1949b037510eff8f05d26da5a3.jpg synonyms: - Ribes coeleste genus: Ribes family: Grossulariaceae links: self: "/api/v1/species/ribes-tenue" plant: "/api/v1/plants/ribes-tenue" genus: "/api/v1/genus/ribes" links: self: "/api/v1/plants" first: "/api/v1/plants?page=1" last: "/api/v1/plants?page=1" meta: total: 6 '401': description: Invalid credentials content: application/json: examples: returns-a-401-response: value: error: true messages: Invalid access token "/api/v1/plants/{id}": get: summary: Retrieve a plant tags: - Plants description: Get a plant operationId: getPlant parameters: - name: id required: true in: path description: The id or the slug of the requested plant schema: type: string security: - token: [] responses: '200': description: Success content: application/json: schema: type: object properties: data: "$ref": "#/components/schemas/plant" meta: type: object properties: last_modified: type: string examples: returns-a-200-response: value: data: id: 376742 common_name: slug: ribes-tenue scientific_name: Ribes tenue main_species_id: 697964 image_url: http://d2seqvvyy3b8p2.cloudfront.net/4234eb1949b037510eff8f05d26da5a3.jpg year: 1906 bibliography: 'Bull. Int. Acad. Sci. Cracovie, Cl. Sci. Math. 6: 290 (1906)' author: Jancz. family_common_name: genus_id: 5882 observations: C. & EC. China vegetable: false links: self: "/api/v1/plants/ribes-tenue" species: "/api/v1/plants/ribes-tenue/species" genus: "/api/v1/genus/ribes" main_species: id: 697964 common_name: slug: ribes-tenue scientific_name: Ribes tenue year: 1906 bibliography: 'Bull. Int. Acad. Sci. Cracovie, Cl. Sci. Math. 6: 290 (1906)' author: Jancz. status: accepted rank: species family_common_name: genus_id: 5882 observations: C. & EC. China image_url: http://d2seqvvyy3b8p2.cloudfront.net/4234eb1949b037510eff8f05d26da5a3.jpg genus: Ribes family: Grossulariaceae duration: images: flower: [] leaf: [] habit: [] fruit: [] bark: [] other: [] common_names: {} distribution: native: - China Southeast - China South-Central - China North-Central flower: color: conspicuous: foliage: texture: color: leaf_retention: fruit_or_seed: conspicuous: color: shape: seed_persistence: specifications: ligneous_type: growth_form: growth_habit: growth_rate: average_height: cm: maximum_height: cm: nitrogen_fixation: shape_and_orientation: toxicity: growth: description: sowing: days_to_harvest: row_spacing: cm: spread: cm: ph_maximum: ph_minimum: light: atmospheric_humidity: growth_months: bloom_months: fruit_months: minimum_precipitation: mm: maximum_precipitation: mm: minimum_root_depth: cm: minimum_temperature: deg_f: deg_c: maximum_temperature: deg_f: deg_c: soil_nutriments: soil_salinity: soil_texture: soil_humidity: links: self: "/api/v1/species/ribes-tenue" plant: "/api/v1/plants/ribes-tenue" genus: "/api/v1/genus/ribes" synonyms: - id: 337309 name: Ribes coeleste author: Jancz. sources: [] sources: - last_update: '2020-06-24T16:21:41.000Z' id: urn:lsid:ipni.org:names:793024-1 name: POWO url: http://powo.science.kew.org/taxon/urn:lsid:ipni.org:names:793024-1 citation: POWO (2019). Plants of the World Online. Facilitated by the Royal Botanic Gardens, Kew. Published on the Internet; http://www.plantsoftheworldonline.org/ Retrieved 2020-06-24 genus: id: 5882 name: Ribes slug: ribes links: self: "/api/v1/genus/ribes" plants: "/api/v1/genus/ribes/plants" species: "/api/v1/genus/ribes/species" family: "/api/v1/families/grossulariaceae" family: id: 339 name: Grossulariaceae common_name: Currant family slug: grossulariaceae links: self: "/api/v1/families/grossulariaceae" division_order: "/api/v1/division_orders/rosales" genus: "/api/v1/families/grossulariaceae/genus" species: - id: 697964 common_name: slug: ribes-tenue scientific_name: Ribes tenue year: 1906 bibliography: 'Bull. Int. Acad. Sci. Cracovie, Cl. Sci. Math. 6: 290 (1906)' author: Jancz. status: accepted rank: species family_common_name: genus_id: 5882 image_url: http://d2seqvvyy3b8p2.cloudfront.net/4234eb1949b037510eff8f05d26da5a3.jpg synonyms: - Ribes coeleste genus: Ribes family: Grossulariaceae links: self: "/api/v1/species/ribes-tenue" plant: "/api/v1/plants/ribes-tenue" genus: "/api/v1/genus/ribes" subspecies: [] varieties: - id: 697966 common_name: slug: ribes-tenue-var-puberulum scientific_name: Ribes tenue var. puberulum year: 2006 bibliography: 'Fl. Yunnanica 12: 254 (2006)' author: H.Chuang status: accepted rank: var family_common_name: genus_id: 5882 image_url: synonyms: [] genus: Ribes family: Grossulariaceae links: self: "/api/v1/species/ribes-tenue-var-puberulum" plant: "/api/v1/plants/ribes-tenue" genus: "/api/v1/genus/ribes" - id: 697967 common_name: slug: ribes-tenue-var-incisum scientific_name: Ribes tenue var. incisum year: 1993 bibliography: 'Acta Phytotax. Sin. 31: 458 (1993)' author: L.T.Lu status: accepted rank: var family_common_name: genus_id: 5882 image_url: synonyms: [] genus: Ribes family: Grossulariaceae links: self: "/api/v1/species/ribes-tenue-var-incisum" plant: "/api/v1/plants/ribes-tenue" genus: "/api/v1/genus/ribes" hybrids: [] forms: [] subvarieties: [] sources: - last_update: '2020-06-24T16:21:41.000Z' id: urn:lsid:ipni.org:names:793024-1 name: POWO url: http://powo.science.kew.org/taxon/urn:lsid:ipni.org:names:793024-1 citation: POWO (2019). Plants of the World Online. Facilitated by the Royal Botanic Gardens, Kew. Published on the Internet; http://www.plantsoftheworldonline.org/ Retrieved 2020-06-24 - last_update: '2020-06-24T16:21:41.000Z' id: urn:lsid:ipni.org:names:77073527-1 name: POWO url: http://powo.science.kew.org/taxon/urn:lsid:ipni.org:names:77073527-1 citation: POWO (2019). Plants of the World Online. Facilitated by the Royal Botanic Gardens, Kew. Published on the Internet; http://www.plantsoftheworldonline.org/ Retrieved 2020-06-24 - last_update: '2020-06-24T16:21:41.000Z' id: urn:lsid:ipni.org:names:974895-1 name: POWO url: http://powo.science.kew.org/taxon/urn:lsid:ipni.org:names:974895-1 citation: POWO (2019). Plants of the World Online. Facilitated by the Royal Botanic Gardens, Kew. Published on the Internet; http://www.plantsoftheworldonline.org/ Retrieved 2020-06-24 meta: last_modified: '2020-07-22T11:16:26.595Z' '401': description: Invalid credentials content: application/json: examples: returns-a-401-response: value: error: true messages: Invalid access token "/api/v1/plants/search": get: summary: Search for a plant tags: - Plants description: |- Search for a plant with the given scientific name, common name, synonym name etc... **Caution:** Setting a filter, a sort or a range on this endpoint will make it significantly slower. If you need a quick response (For a search input, for example), make sure you're only using the `q` parameter. operationId: searchPlants parameters: - name: q required: true in: query description: The string to search schema: type: string - name: page in: query required: false description: The page to fetch schema: type: number - name: filter in: query required: false type: object description: Filter on values schema: "$ref": "#/components/schemas/filters_plants" - name: filter_not in: query required: false type: object description: Exclude results matching null values schema: "$ref": "#/components/schemas/filters_not_species" - name: order in: query required: false type: object description: Sort on values schema: "$ref": "#/components/schemas/sorts_plants" - name: range in: query required: false type: object description: Range on values schema: "$ref": "#/components/schemas/ranges_plants" security: - token: [] responses: '200': description: Success content: application/json: schema: type: object properties: data: type: array items: "$ref": "#/components/schemas/species_light" links: type: object properties: self: type: string description: A link to the current page of the collection first: type: string description: A link to the first page of the collection next: type: string description: A link to the next page of the collection prev: type: string description: A link to the previous page of the collection last: type: string description: A link to the last page of the collection required: - self meta: type: object properties: total: type: integer examples: returns-a-200-response: value: data: [] links: self: "/api/v1/plants/search?q=cocos" first: "/api/v1/plants/search?page=1&q=cocos" last: "/api/v1/plants/search?page=1&q=cocos" meta: total: 0 "/api/v1/plants/{id}/report": post: summary: Report an error tags: - Plants description: A short API call to report an error regarding a plant entry operationId: reportPlants parameters: - name: id required: true in: path description: The id or the slug of the requested species schema: type: string security: - token: [] responses: '200': description: Success content: application/json: schema: type: object properties: data: "$ref": "#/components/schemas/correction" meta: type: object properties: last_modified: type: string examples: returns-a-200-response: value: data: id: 1 record_type: Species record_id: 106648 user_id: 19 warning_type: report change_status: pending change_type: update accepted_by: notes: The flower color is red created_at: '2020-07-22T11:16:32.301Z' updated_at: '2020-07-22T11:16:32.303Z' correction: changes: meta: last_modified: '2020-07-22T11:16:32.303Z' '401': description: Invalid credentials content: application/json: examples: returns-a-401-response: value: error: true messages: Invalid access token requestBody: content: application/json: schema: type: object properties: notes: type: string example: The flower color is red description: An optional note about the incorrect data "/api/v1/distributions/{zone_id}/plants": get: summary: List plants in a distribution zone tags: - Plants description: List plants in the requested zone operationId: listPlantsZone security: - token: [] parameters: - name: zone_id required: true in: path description: The zone id or slug schema: type: string - name: filter in: query required: false type: object description: Filter on values schema: "$ref": "#/components/schemas/filters_species" - name: filter_not in: query required: false type: object description: Exclude results matching null values schema: "$ref": "#/components/schemas/filters_not_species" - name: order in: query required: false type: object description: Sort on values schema: "$ref": "#/components/schemas/sorts_species" - name: range in: query required: false type: object description: Range on values schema: "$ref": "#/components/schemas/ranges_species" - name: page in: query required: false description: The page to fetch schema: type: number responses: '200': description: Success content: application/json: schema: type: object properties: data: type: array items: "$ref": "#/components/schemas/species_light" links: type: object properties: self: type: string description: A link to the current page of the collection first: type: string description: A link to the first page of the collection next: type: string description: A link to the next page of the collection prev: type: string description: A link to the previous page of the collection last: type: string description: A link to the last page of the collection required: - self meta: type: object properties: total: type: integer examples: returns-a-200-response: value: data: - id: 151545 common_name: dwarf honeysuckle slug: lonicera-xylosteum scientific_name: Lonicera xylosteum year: 1753 bibliography: 'Sp. Pl.: 174 (1753)' author: L. status: accepted rank: species family_common_name: Honeysuckle family genus_id: 1700 image_url: https://bs.floristic.org/image/o/54fb8312373faf0b7a1c7b84979331cc9d7619fc synonyms: - Lonicera dumetorum - Chamaecerasus xylosteum - Lonicera ochroleuca - Xylosteon dumetorum - Caprifolium xylosteum - Caprifolium dumetorum - Chamaecerasus dumetorum - Lonicera rubra - Euchylia villosa genus: Lonicera family: Caprifoliaceae links: self: "/api/v1/species/lonicera-xylosteum" plant: "/api/v1/plants/lonicera-xylosteum" genus: "/api/v1/genus/lonicera" - id: 106847 common_name: kinnikinnick slug: arctostaphylos-uva-ursi scientific_name: Arctostaphylos uva-ursi year: 1825 bibliography: 'Syst. Veg. 2: 287 (1825)' author: Spreng. (L.) status: accepted rank: species family_common_name: Heath family genus_id: 599 image_url: https://bs.floristic.org/image/o/aa4f6610a4ebb4eb9a2e22f7853d5d038b048660 synonyms: - Arctostaphylos uva-ursi var. saxicola - Arctostaphylos adenotricha - Arctostaphylos uva-ursi var. adenotricha - Arctostaphylos uva-ursi var. coactilis - Arctostaphylos uva-ursi var. leobreweri - Arctostaphylos uva-ursi var. marinensis - Arctostaphylos uva-ursi var. pacifica - Arctostaphylos uva-ursi var. stipitata - Arctostaphylos uva-ursi var. suborbiculata - Uva-ursi buxifolia - Arctostaphylos uva-ursi subsp. adenotricha - Arctostaphylos uva-ursi subsp. stipitata - Arbutus uva-ursi - Arctostaphylos uva-ursi subsp. monoensis - Uva-ursi uva-ursi var. coactilis - Arctostaphylos procumbens - Uva-ursi procumbens - Arctostaphylos uva-ursi var. fendleriana - Uva-ursi procumbens var. coactilis - Arbutus officinalis - Uva-ursi procumbens var. adenotricha - Arctostaphylos uva-ursi subsp. coactilis - Arbutus buxifolia - Arctostaphylos uva-ursi f. marinensis - Arbutus procumbens - Daphnidostaphylis fendleriana - Arctostaphylos uva-ursi subsp. crassifolius - Arctostaphylos uva-ursi f. coactilis - Arctostaphylos uva-ursi subsp. longipilosa - Arctostaphylos officinalis genus: Arctostaphylos family: Ericaceae links: self: "/api/v1/species/arctostaphylos-uva-ursi" plant: "/api/v1/plants/arctostaphylos-uva-ursi" genus: "/api/v1/genus/arctostaphylos" links: self: "/api/v1/plants?zone_id=czechoslovakia" first: "/api/v1/plants?page=1&zone_id=czechoslovakia" last: "/api/v1/plants?page=1&zone_id=czechoslovakia" meta: total: 2 '401': description: Invalid credentials content: application/json: examples: returns-a-401-response: value: error: true messages: Invalid access token "/api/v1/genus/{genus_id}/plants": get: summary: List plants of a genus tags: - Plants description: List plants of the requested genus operationId: listPlantsGenus security: - token: [] parameters: - name: genus_id required: true in: path description: The genus id or slug schema: type: string - name: filter in: query required: false type: object description: Filter on values schema: "$ref": "#/components/schemas/filters_species" - name: filter_not in: query required: false type: object description: Exclude results matching null values schema: "$ref": "#/components/schemas/filters_not_species" - name: order in: query required: false type: object description: Sort on values schema: "$ref": "#/components/schemas/sorts_species" - name: range in: query required: false type: object description: Range on values schema: "$ref": "#/components/schemas/ranges_species" - name: page in: query required: false description: The page to fetch schema: type: number responses: '200': description: Success content: application/json: schema: type: object properties: data: type: array items: "$ref": "#/components/schemas/species_light" links: type: object properties: self: type: string description: A link to the current page of the collection first: type: string description: A link to the first page of the collection next: type: string description: A link to the next page of the collection prev: type: string description: A link to the previous page of the collection last: type: string description: A link to the last page of the collection required: - self meta: type: object properties: total: type: integer examples: returns-a-200-response: value: data: - id: 697964 common_name: slug: ribes-tenue scientific_name: Ribes tenue year: 1906 bibliography: 'Bull. Int. Acad. Sci. Cracovie, Cl. Sci. Math. 6: 290 (1906)' author: Jancz. status: accepted rank: species family_common_name: genus_id: 5882 image_url: http://d2seqvvyy3b8p2.cloudfront.net/4234eb1949b037510eff8f05d26da5a3.jpg synonyms: - Ribes coeleste genus: Ribes family: Grossulariaceae links: self: "/api/v1/species/ribes-tenue" plant: "/api/v1/plants/ribes-tenue" genus: "/api/v1/genus/ribes" links: self: "/api/v1/plants?genus_id=ribes" first: "/api/v1/plants?genus_id=ribes&page=1" last: "/api/v1/plants?genus_id=ribes&page=1" meta: total: 1 '401': description: Invalid credentials content: application/json: examples: returns-a-401-response: value: error: true messages: Invalid access token "/api/v1/species": get: summary: List species tags: - Species description: List species operationId: listSpecies security: - token: [] parameters: - name: filter in: query required: false type: object description: Filter on values schema: "$ref": "#/components/schemas/filters_species" - name: filter_not in: query required: false type: object description: Exclude results matching null values schema: "$ref": "#/components/schemas/filters_not_species" - name: order in: query required: false type: object description: Sort on values schema: "$ref": "#/components/schemas/sorts_species" - name: range in: query required: false type: object description: Range on values schema: "$ref": "#/components/schemas/ranges_species" - name: page in: query required: false description: The page to fetch schema: type: number responses: '200': description: Success content: application/json: schema: type: object properties: data: type: array items: "$ref": "#/components/schemas/species_light" links: type: object properties: self: type: string description: A link to the current page of the collection first: type: string description: A link to the first page of the collection next: type: string description: A link to the next page of the collection prev: type: string description: A link to the previous page of the collection last: type: string description: A link to the last page of the collection required: - self meta: type: object properties: total: type: integer examples: returns-a-200-response: value: data: - id: 151545 common_name: dwarf honeysuckle slug: lonicera-xylosteum scientific_name: Lonicera xylosteum year: 1753 bibliography: 'Sp. Pl.: 174 (1753)' author: L. status: accepted rank: species family_common_name: Honeysuckle family genus_id: 1700 image_url: https://bs.floristic.org/image/o/54fb8312373faf0b7a1c7b84979331cc9d7619fc synonyms: - Lonicera dumetorum - Chamaecerasus xylosteum - Lonicera ochroleuca - Xylosteon dumetorum - Caprifolium xylosteum - Caprifolium dumetorum - Chamaecerasus dumetorum - Lonicera rubra - Euchylia villosa genus: Lonicera family: Caprifoliaceae links: self: "/api/v1/species/lonicera-xylosteum" plant: "/api/v1/plants/lonicera-xylosteum" genus: "/api/v1/genus/lonicera" - id: 1164724 common_name: slug: abies-alba scientific_name: Abies alba year: bibliography: author: Mill. status: accepted rank: species family_common_name: genus_id: 4 image_url: synonyms: [] genus: Abies family: Pinaceae links: self: "/api/v1/species/abies-alba" plant: "/api/v1/plants/abies-alba" genus: "/api/v1/genus/abies" - id: 106847 common_name: kinnikinnick slug: arctostaphylos-uva-ursi scientific_name: Arctostaphylos uva-ursi year: 1825 bibliography: 'Syst. Veg. 2: 287 (1825)' author: Spreng. (L.) status: accepted rank: species family_common_name: Heath family genus_id: 599 image_url: https://bs.floristic.org/image/o/aa4f6610a4ebb4eb9a2e22f7853d5d038b048660 synonyms: - Arctostaphylos uva-ursi var. saxicola - Arctostaphylos adenotricha - Arctostaphylos uva-ursi var. adenotricha - Arctostaphylos uva-ursi var. coactilis - Arctostaphylos uva-ursi var. leobreweri - Arctostaphylos uva-ursi var. marinensis - Arctostaphylos uva-ursi var. pacifica - Arctostaphylos uva-ursi var. stipitata - Arctostaphylos uva-ursi var. suborbiculata - Uva-ursi buxifolia - Arctostaphylos uva-ursi subsp. adenotricha - Arctostaphylos uva-ursi subsp. stipitata - Arbutus uva-ursi - Arctostaphylos uva-ursi subsp. monoensis - Uva-ursi uva-ursi var. coactilis - Arctostaphylos procumbens - Uva-ursi procumbens - Arctostaphylos uva-ursi var. fendleriana - Uva-ursi procumbens var. coactilis - Arbutus officinalis - Uva-ursi procumbens var. adenotricha - Arctostaphylos uva-ursi subsp. coactilis - Arbutus buxifolia - Arctostaphylos uva-ursi f. marinensis - Arbutus procumbens - Daphnidostaphylis fendleriana - Arctostaphylos uva-ursi subsp. crassifolius - Arctostaphylos uva-ursi f. coactilis - Arctostaphylos uva-ursi subsp. longipilosa - Arctostaphylos officinalis genus: Arctostaphylos family: Ericaceae links: self: "/api/v1/species/arctostaphylos-uva-ursi" plant: "/api/v1/plants/arctostaphylos-uva-ursi" genus: "/api/v1/genus/arctostaphylos" - id: 108793 common_name: alpine aster slug: aster-alpinus scientific_name: Aster alpinus year: 1753 bibliography: "(1753). Sp. Pl. 2" author: L. status: accepted rank: species family_common_name: Aster family genus_id: 272 image_url: https://bs.floristic.org/image/o/2ed21d78cd8f476bd7582866875d02c0b4b7c998 synonyms: - Aster garibaldii - Diplactis alpina - Aster korshinskyi - Krylovia novopokrovskyi - Aster pulchellus - Aster chrysocomoides - Aster wolfii - Aster scabris - Rhinactinidia novopokrovskyi - Borkonstia novopokrovskyi - Aster novopokrovskyi - Aster alpinus var. fallax - Aster nivalis genus: Aster family: Asteraceae links: self: "/api/v1/species/aster-alpinus" plant: "/api/v1/plants/aster-alpinus" genus: "/api/v1/genus/aster" - id: 315289 common_name: slug: maireana-tomentosa scientific_name: Maireana tomentosa year: 1840 bibliography: Chenop. Monogr. Enum., 96, 96, 1840 author: Moq. status: accepted rank: species family_common_name: genus_id: 4407 image_url: http://d2seqvvyy3b8p2.cloudfront.net/a1d2563c0435af30c49c0db543f4e2b1.jpg synonyms: - Kochia tomentosa var. enchylaenoides - Kochia enchylaenoides genus: Maireana family: Amaranthaceae links: self: "/api/v1/species/maireana-tomentosa" plant: "/api/v1/plants/maireana-tomentosa" genus: "/api/v1/genus/maireana" - id: 1160785 common_name: kinnikinnick slug: arctostaphylos-uva-ursi-subsp-uva-ursi scientific_name: Arctostaphylos uva-ursi subsp. uva-ursi year: 1825 bibliography: 'Syst. Veg. 2: 287 (1825)' author: "(L.) Spreng." status: unknown rank: ssp family_common_name: Heath family genus_id: 599 image_url: synonyms: - Uva-Ursi uva-ursi genus: Arctostaphylos family: Ericaceae links: self: "/api/v1/species/arctostaphylos-uva-ursi-subsp-uva-ursi" plant: "/api/v1/plants/arctostaphylos-uva-ursi" genus: "/api/v1/genus/arctostaphylos" - id: 108798 common_name: alpine aster slug: aster-alpinus-var-vierhapperi scientific_name: Aster alpinus var. vierhapperi year: 1955 bibliography: 'Vasc. Pl. Pacif. N.W. 5: 76 (1955)' author: Cronquist (Onno) status: accepted rank: var family_common_name: Aster family genus_id: 272 image_url: synonyms: - Aster americanus - Aster alpinus subsp. vierhapperi - Aster culminis - Diplactis alpina subsp. vierhapperi genus: Aster family: Asteraceae links: self: "/api/v1/species/aster-alpinus-var-vierhapperi" plant: "/api/v1/plants/aster-alpinus" genus: "/api/v1/genus/aster" - id: 108796 common_name: alpine aster slug: aster-alpinus-var-serpentimontanus scientific_name: Aster alpinus var. serpentimontanus year: 1985 bibliography: 'Fl. Reipubl. Popularis Sin. 74: 204 (1985)' author: Y.Ling (Tamamsch.) status: accepted rank: var family_common_name: Aster family genus_id: 272 image_url: synonyms: - Aster serpentimontanus - Aster alpinus subsp. serpentimontanus - Aster tolmatschevii - Aster alpinus subsp. tolmatschevii - Aster fallax genus: Aster family: Asteraceae links: self: "/api/v1/species/aster-alpinus-var-serpentimontanus" plant: "/api/v1/plants/aster-alpinus" genus: "/api/v1/genus/aster" - id: 108794 common_name: alpine aster slug: aster-alpinus-var-alpinus scientific_name: Aster alpinus var. alpinus year: 1984 bibliography: 'Folia Mus. Rerum Nat. Bohemiae Occid., Bot. 21: 12 (1984)' author: L. status: unknown rank: var family_common_name: Aster family genus_id: 272 image_url: synonyms: [] genus: Aster family: Asteraceae links: self: "/api/v1/species/aster-alpinus-var-alpinus" plant: "/api/v1/plants/aster-alpinus" genus: "/api/v1/genus/aster" - id: 292293 common_name: slug: puya-araneosa scientific_name: Puya araneosa year: 1954 bibliography: 'Phytologia 5: 48 (1954)' author: L.B.Sm. status: accepted rank: species family_common_name: Bromeliad family genus_id: 10052 image_url: synonyms: [] genus: Puya family: Bromeliaceae links: self: "/api/v1/species/puya-araneosa" plant: "/api/v1/plants/puya-araneosa" genus: "/api/v1/genus/puya" - id: 106648 common_name: kinnikinnick slug: arctostaphylos-uva-ursi-ssp-coloradensis scientific_name: Arctostaphylos uva-ursi ssp. coloradensis year: 1825 bibliography: 'Syst. Veg. 2: 287 (1825)' author: "(L.) Spreng." status: unknown rank: ssp family_common_name: Heath family genus_id: 599 image_url: synonyms: [] genus: Arctostaphylos family: Ericaceae links: self: "/api/v1/species/arctostaphylos-uva-ursi-ssp-coloradensis" plant: "/api/v1/plants/arctostaphylos-uva-ursi" genus: "/api/v1/genus/arctostaphylos" - id: 106765 common_name: kinnikinnick slug: arctostaphylos-uva-ursi-ssp-myrtifolia scientific_name: Arctostaphylos uva-ursi ssp. myrtifolia year: 1825 bibliography: 'Syst. Veg. 2: 287 (1825)' author: "(L.) Spreng." status: unknown rank: ssp family_common_name: Heath family genus_id: 599 image_url: synonyms: [] genus: Arctostaphylos family: Ericaceae links: self: "/api/v1/species/arctostaphylos-uva-ursi-ssp-myrtifolia" plant: "/api/v1/plants/arctostaphylos-uva-ursi" genus: "/api/v1/genus/arctostaphylos" - id: 106776 common_name: kinnikinnick slug: arctostaphylos-uva-ursi-ssp-sensitiva scientific_name: Arctostaphylos uva-ursi ssp. sensitiva year: 1825 bibliography: 'Syst. Veg. 2: 287 (1825)' author: "(L.) Spreng." status: unknown rank: ssp family_common_name: Heath family genus_id: 599 image_url: synonyms: [] genus: Arctostaphylos family: Ericaceae links: self: "/api/v1/species/arctostaphylos-uva-ursi-ssp-sensitiva" plant: "/api/v1/plants/arctostaphylos-uva-ursi" genus: "/api/v1/genus/arctostaphylos" - id: 106853 common_name: kinnikinnick slug: arctostaphylos-uva-ursi-ssp-longipilosa scientific_name: Arctostaphylos uva-ursi ssp. longipilosa year: 1825 bibliography: 'Syst. Veg. 2: 287 (1825)' author: "(L.) Spreng." status: unknown rank: ssp family_common_name: Heath family genus_id: 599 image_url: synonyms: [] genus: Arctostaphylos family: Ericaceae links: self: "/api/v1/species/arctostaphylos-uva-ursi-ssp-longipilosa" plant: "/api/v1/plants/arctostaphylos-uva-ursi" genus: "/api/v1/genus/arctostaphylos" - id: 106856 common_name: kinnikinnick slug: arctostaphylos-uva-ursi-ssp-monoensis scientific_name: Arctostaphylos uva-ursi ssp. monoensis year: 1825 bibliography: 'Syst. Veg. 2: 287 (1825)' author: "(L.) Spreng." status: unknown rank: ssp family_common_name: Heath family genus_id: 599 image_url: synonyms: [] genus: Arctostaphylos family: Ericaceae links: self: "/api/v1/species/arctostaphylos-uva-ursi-ssp-monoensis" plant: "/api/v1/plants/arctostaphylos-uva-ursi" genus: "/api/v1/genus/arctostaphylos" - id: 108799 common_name: alpine aster slug: aster-alpinus-ssp-vierhapperi scientific_name: Aster alpinus ssp. vierhapperi year: 1984 bibliography: 'Folia Mus. Rerum Nat. Bohemiae Occid., Bot. 21: 12 (1984)' author: L. status: unknown rank: ssp family_common_name: Aster family genus_id: 272 image_url: synonyms: [] genus: Aster family: Asteraceae links: self: "/api/v1/species/aster-alpinus-ssp-vierhapperi" plant: "/api/v1/plants/aster-alpinus" genus: "/api/v1/genus/aster" - id: 399264 common_name: alpine aster slug: aster-alpinus-subsp-bohemicus scientific_name: Aster alpinus subsp. bohemicus year: 1984 bibliography: 'Folia Mus. Rerum Nat. Bohemiae Occid., Bot. 21: 12 (1984)' author: "(Reichenb.) Dostál" status: accepted rank: ssp family_common_name: Aster family genus_id: 272 image_url: synonyms: - Aster alpinus var. glaber genus: Aster family: Asteraceae links: self: "/api/v1/species/aster-alpinus-subsp-bohemicus" plant: "/api/v1/plants/aster-alpinus" genus: "/api/v1/genus/aster" - id: 399266 common_name: alpine aster slug: aster-alpinus-var-diversisquamus scientific_name: Aster alpinus var. diversisquamus year: 1985 bibliography: 'Fl. Reipubl. Popularis Sin. 74: 359 (1985)' author: Y.Ling status: accepted rank: var family_common_name: Aster family genus_id: 272 image_url: synonyms: [] genus: Aster family: Asteraceae links: self: "/api/v1/species/aster-alpinus-var-diversisquamus" plant: "/api/v1/plants/aster-alpinus" genus: "/api/v1/genus/aster" - id: 106690 common_name: kinnikinnick slug: arctostaphylos-uva-ursi-ssp-emundsii scientific_name: Arctostaphylos uva-ursi ssp. emundsii year: 1825 bibliography: 'Syst. Veg. 2: 287 (1825)' author: "(L.) Spreng." status: unknown rank: ssp family_common_name: Heath family genus_id: 599 image_url: synonyms: [] genus: Arctostaphylos family: Ericaceae links: self: "/api/v1/species/arctostaphylos-uva-ursi-ssp-emundsii" plant: "/api/v1/plants/arctostaphylos-uva-ursi" genus: "/api/v1/genus/arctostaphylos" - id: 315292 common_name: slug: maireana-tomentosa-subsp-urceolala scientific_name: Maireana tomentosa subsp. urceolala year: 1975 bibliography: 'Nuytsia 2: 49 (1975)' author: Paul G.Wilson status: accepted rank: ssp family_common_name: genus_id: 4407 image_url: synonyms: [] genus: Maireana family: Amaranthaceae links: self: "/api/v1/species/maireana-tomentosa-subsp-urceolala" plant: "/api/v1/plants/maireana-tomentosa" genus: "/api/v1/genus/maireana" links: self: "/api/v1/species" first: "/api/v1/species?page=1" next: "/api/v1/species?page=2" last: "/api/v1/species?page=2" meta: total: 28 '401': description: Invalid credentials content: application/json: examples: returns-a-401-response: value: error: true messages: Invalid access token "/api/v1/species/{id}": get: summary: Retrieve a species tags: - Species description: Get a species operationId: getSpecies parameters: - name: id required: true in: path description: The id or the slug of the requested species schema: type: string security: - token: [] responses: '200': description: Success content: application/json: schema: type: object properties: data: "$ref": "#/components/schemas/species" meta: type: object properties: last_modified: type: string images_count: type: integer sources_count: type: integer synonyms_count: type: integer examples: returns-a-200-response: value: data: id: 106648 common_name: kinnikinnick slug: arctostaphylos-uva-ursi-ssp-coloradensis scientific_name: Arctostaphylos uva-ursi ssp. coloradensis year: 1825 bibliography: 'Syst. Veg. 2: 287 (1825)' author: "(L.) Spreng." status: unknown rank: ssp family_common_name: Heath family genus_id: 599 observations: Subarctic to N., W. & C. U.S.A. image_url: genus: Arctostaphylos family: Ericaceae duration: images: flower: [] leaf: [] habit: [] fruit: [] bark: [] other: [] common_names: {} distribution: {} flower: color: conspicuous: true foliage: texture: coarse color: leaf_retention: true fruit_or_seed: conspicuous: true color: shape: seed_persistence: true specifications: ligneous_type: growth_form: Multiple Stem growth_habit: Subshrub, Shrub growth_rate: Moderate average_height: cm: 15 maximum_height: cm: 15 nitrogen_fixation: None shape_and_orientation: Prostrate toxicity: none growth: description: sowing: days_to_harvest: row_spacing: cm: spread: cm: ph_maximum: 8.0 ph_minimum: 5.5 light: atmospheric_humidity: growth_months: bloom_months: fruit_months: minimum_precipitation: mm: 355 maximum_precipitation: mm: 1143 minimum_root_depth: cm: 25 minimum_temperature: deg_f: -33 deg_c: -36 maximum_temperature: deg_f: deg_c: soil_nutriments: soil_salinity: soil_texture: soil_humidity: links: self: "/api/v1/species/arctostaphylos-uva-ursi-ssp-coloradensis" plant: "/api/v1/plants/arctostaphylos-uva-ursi" genus: "/api/v1/genus/arctostaphylos" synonyms: [] sources: - last_update: '2020-06-21T20:07:23.000Z' id: ARUV name: USDA url: https://plants.usda.gov/core/profile?symbol=ARUV citation: https://plants.sc.egov.usda.gov/core/profile?symbol=ARUV meta: images_count: 0 sources_count: 1 synonyms_count: 0 last_modified: '2020-07-22T11:16:26.721Z' '401': description: Invalid credentials content: application/json: examples: returns-a-401-response: value: error: true messages: Invalid access token "/api/v1/species/search": get: summary: Search for a species tags: - Species description: |- Search for a species with the given scientific name, common name, synonym name etc... **Caution:** Setting a filter, a sort or a range on this endpoint will make it significantly slower. If you need a quick response (For a search input, for example), make sure you're only using the `q` parameter. operationId: searchSpecies parameters: - name: q required: true in: query description: The string to search schema: type: string - name: page in: query required: false description: The page to fetch schema: type: number - name: filter in: query required: false type: object description: Filter on values schema: "$ref": "#/components/schemas/filters_species" - name: filter_not in: query required: false type: object description: Exclude results matching null values schema: "$ref": "#/components/schemas/filters_not_species" - name: order in: query required: false type: object description: Sort on values schema: "$ref": "#/components/schemas/sorts_species" - name: range in: query required: false type: object description: Range on values schema: "$ref": "#/components/schemas/ranges_species" security: - token: [] responses: '200': description: Success content: application/json: schema: type: object properties: data: type: array items: "$ref": "#/components/schemas/species_light" links: type: object properties: self: type: string description: A link to the current page of the collection first: type: string description: A link to the first page of the collection next: type: string description: A link to the next page of the collection prev: type: string description: A link to the previous page of the collection last: type: string description: A link to the last page of the collection required: - self meta: type: object properties: total: type: integer examples: returns-a-200-response: value: data: [] links: self: "/api/v1/species/search?q=cocos" first: "/api/v1/species/search?page=1&q=cocos" last: "/api/v1/species/search?page=1&q=cocos" meta: total: 0 "/api/v1/species/{id}/report": post: summary: Report an error tags: - Species description: A short API call to report an error regarding a species entry operationId: reportSpecies parameters: - name: id required: true in: path description: The id or the slug of the requested species schema: type: string security: - token: [] responses: '200': description: Success content: application/json: schema: type: object properties: data: "$ref": "#/components/schemas/correction" meta: type: object properties: last_modified: type: string examples: returns-a-200-response: value: data: id: 2 record_type: Species record_id: 106648 user_id: 25 warning_type: report change_status: pending change_type: update accepted_by: notes: The flower color is red created_at: '2020-07-22T11:16:32.615Z' updated_at: '2020-07-22T11:16:32.616Z' correction: changes: meta: last_modified: '2020-07-22T11:16:32.616Z' '401': description: Invalid credentials content: application/json: examples: returns-a-401-response: value: error: true messages: Invalid access token requestBody: content: application/json: schema: type: object properties: notes: type: string example: The flower color is red description: An optional note about the incorrect data "/api/v1/distributions": get: summary: List distributions zones tags: - Distributions description: | List distributions zones. Zones are following the WGSRPD convention. WGSRPD provides an agreed system of geographical units at approximately "country" level and upwards for use in recording plant distributions. It allows adopting organizations to compare and exchange data with each other without loss of information due to incompatible geographical boundaries. [Read more on the TDWG website](https://www.tdwg.org/standards/wgsrpd/). operationId: listDistributions security: - token: [] parameters: - name: page in: query required: false description: The page to fetch schema: type: number responses: '200': description: Success content: application/json: schema: type: object properties: data: type: array items: "$ref": "#/components/schemas/zone" links: type: object properties: self: type: string description: A link to the current page of the collection first: type: string description: A link to the first page of the collection next: type: string description: A link to the next page of the collection prev: type: string description: A link to the previous page of the collection last: type: string description: A link to the last page of the collection required: - self meta: type: object properties: total: type: integer examples: returns-a-200-response: value: data: - id: 151 name: Afghanistan slug: afghanistan tdwg_code: AFG tdwg_level: 3 species_count: 0 links: self: "/api/v1/distributions/afghanistan" plants: "/api/v1/distributions/afghanistan/plants" species: "/api/v1/distributions/afghanistan/species" - id: 144 name: Alabama slug: alabama tdwg_code: ALA tdwg_level: 3 species_count: 0 links: self: "/api/v1/distributions/alabama" plants: "/api/v1/distributions/alabama/plants" species: "/api/v1/distributions/alabama/species" - id: 325 name: Alaska slug: alaska tdwg_code: ASK tdwg_level: 3 species_count: 2 links: self: "/api/v1/distributions/alaska" plants: "/api/v1/distributions/alaska/plants" species: "/api/v1/distributions/alaska/species" - id: 93 name: Albania slug: albania tdwg_code: ALB tdwg_level: 3 species_count: 3 links: self: "/api/v1/distributions/albania" plants: "/api/v1/distributions/albania/plants" species: "/api/v1/distributions/albania/species" - id: 326 name: Alberta slug: alberta tdwg_code: ABT tdwg_level: 3 species_count: 2 links: self: "/api/v1/distributions/alberta" plants: "/api/v1/distributions/alberta/plants" species: "/api/v1/distributions/alberta/species" - id: 212 name: Aldabra slug: aldabra tdwg_code: ALD tdwg_level: 3 species_count: 0 links: self: "/api/v1/distributions/aldabra" plants: "/api/v1/distributions/aldabra/plants" species: "/api/v1/distributions/aldabra/species" - id: 356 name: Aleutian Is. slug: aleutian-is tdwg_code: ALU tdwg_level: 3 species_count: 1 links: self: "/api/v1/distributions/aleutian-is" plants: "/api/v1/distributions/aleutian-is/plants" species: "/api/v1/distributions/aleutian-is/species" - id: 137 name: Algeria slug: algeria tdwg_code: ALG tdwg_level: 3 species_count: 0 links: self: "/api/v1/distributions/algeria" plants: "/api/v1/distributions/algeria/plants" species: "/api/v1/distributions/algeria/species" - id: 303 name: Altay slug: altay tdwg_code: ALT tdwg_level: 3 species_count: 2 links: self: "/api/v1/distributions/altay" plants: "/api/v1/distributions/altay/plants" species: "/api/v1/distributions/altay/species" - id: 355 name: Amsterdam-St.Paul Is slug: amsterdam-st-paul-is tdwg_code: ASP tdwg_level: 3 species_count: 0 links: self: "/api/v1/distributions/amsterdam-st-paul-is" plants: "/api/v1/distributions/amsterdam-st-paul-is/plants" species: "/api/v1/distributions/amsterdam-st-paul-is/species" - id: 304 name: Amur slug: amur tdwg_code: AMU tdwg_level: 3 species_count: 2 links: self: "/api/v1/distributions/amur" plants: "/api/v1/distributions/amur/plants" species: "/api/v1/distributions/amur/species" - id: 39 name: Andaman Is. slug: andaman-is tdwg_code: AND tdwg_level: 3 species_count: 0 links: self: "/api/v1/distributions/andaman-is" plants: "/api/v1/distributions/andaman-is/plants" species: "/api/v1/distributions/andaman-is/species" - id: 4 name: Angola slug: angola tdwg_code: ANG tdwg_level: 3 species_count: 0 links: self: "/api/v1/distributions/angola" plants: "/api/v1/distributions/angola/plants" species: "/api/v1/distributions/angola/species" - id: 367 name: Antarctica slug: antarctica tdwg_code: ANT tdwg_level: 3 species_count: 0 links: self: "/api/v1/distributions/antarctica" plants: "/api/v1/distributions/antarctica/plants" species: "/api/v1/distributions/antarctica/species" - id: 354 name: Antipodean Is. slug: antipodean-is tdwg_code: ATP tdwg_level: 3 species_count: 0 links: self: "/api/v1/distributions/antipodean-is" plants: "/api/v1/distributions/antipodean-is/plants" species: "/api/v1/distributions/antipodean-is/species" - id: 169 name: Argentina Northeast slug: argentina-northeast tdwg_code: AGE tdwg_level: 3 species_count: 0 links: self: "/api/v1/distributions/argentina-northeast" plants: "/api/v1/distributions/argentina-northeast/plants" species: "/api/v1/distributions/argentina-northeast/species" - id: 171 name: Argentina Northwest slug: argentina-northwest tdwg_code: AGW tdwg_level: 3 species_count: 0 links: self: "/api/v1/distributions/argentina-northwest" plants: "/api/v1/distributions/argentina-northwest/plants" species: "/api/v1/distributions/argentina-northwest/species" - id: 264 name: Argentina South slug: argentina-south tdwg_code: AGS tdwg_level: 3 species_count: 0 links: self: "/api/v1/distributions/argentina-south" plants: "/api/v1/distributions/argentina-south/plants" species: "/api/v1/distributions/argentina-south/species" - id: 164 name: Arizona slug: arizona tdwg_code: ARI tdwg_level: 3 species_count: 1 links: self: "/api/v1/distributions/arizona" plants: "/api/v1/distributions/arizona/plants" species: "/api/v1/distributions/arizona/species" - id: 227 name: Arkansas slug: arkansas tdwg_code: ARK tdwg_level: 3 species_count: 0 links: self: "/api/v1/distributions/arkansas" plants: "/api/v1/distributions/arkansas/plants" species: "/api/v1/distributions/arkansas/species" links: self: "/api/v1/distributions" first: "/api/v1/distributions?page=1" next: "/api/v1/distributions?page=2" last: "/api/v1/distributions?page=19" meta: total: 367 '401': description: Invalid credentials content: application/json: examples: returns-a-401-response: value: error: true messages: Invalid access token "/api/v1/distributions/{id}": get: summary: Retrieve a distribution zone tags: - Distributions description: Get a zone operationId: getZone parameters: - name: id required: true in: path description: The id or the slug of the requested zone schema: type: string security: - token: [] responses: '200': description: Success content: application/json: schema: type: object properties: data: "$ref": "#/components/schemas/zone" meta: type: object properties: last_modified: type: string examples: returns-a-200-response: value: data: id: 1 name: Northern Provinces slug: northern-provinces tdwg_code: TVL tdwg_level: 3 species_count: 0 links: self: "/api/v1/distributions/northern-provinces" plants: "/api/v1/distributions/northern-provinces/plants" species: "/api/v1/distributions/northern-provinces/species" meta: last_modified: '2020-07-22T11:16:25.208Z' '401': description: Invalid credentials content: application/json: examples: returns-a-401-response: value: error: true messages: Invalid access token "/api/auth/claim": post: summary: Request a client-side token tags: - Auth description: 'If you need to perform client-side requests, you will have to request a client-side token from you backend, and get a JWT token from this API call in return. This token will be usable on the client side. This call need your secret access token, the url of the website the client side requests will come from and optionally the client IP address. ' operationId: claimClientSideToken security: - token: [] parameters: [] responses: '200': description: Success content: application/json: schema: type: object properties: expiration: type: string example: 07-13-2020 13:41 description: The expiration time of the token. After this time, you'll have to request a token again token: type: string example: eyJhbGciOiJIUzI1NaJ9.eyJ1c2VyX2lkIjoxMDYsIe9yaWdpbiI6Imh0dHA6Ly9wb2NhbGhvc3Q6MzIzMyIsImlwIjoiOjoxIiwiZXhwIjoxNTk0NjQwNTEzfQ.TyqKyKxwsnn7TZsLAfS8OTmTUPk87CSXlk6a2wQU9co description: The client-side access token, that you'll use instead of your access token in the `token` parameter examples: returns-a-200-response: value: token: eyJhbGciOiJIUzI1NiJ9.eyJ1c2VyX2lkIjoyOCwib3JpZ2luIjoiaHR0cDovL2xvY2FsaG9zdDoxMjM0IiwiaXAiOiI6OjEiLCJleHBpcmUiOiIyMDIwLTA3LTIzIDEzOjE2OjMyICswMjAwIiwiZXhwIjoxNTk1NTAyOTkyfQ.Z6WYx7BYiPEjVCIfdhx3Hq78u0Rv4WSOFyS6acsKoIs expiration: 07-23-2020 13:16 '401': description: Invalid credentials content: application/json: examples: returns-a-401-response: value: error: true messages: Invalid access token '422': description: Missing parameters content: application/json: examples: returns-a-422-response: value: error: true message: 'param is missing or the value is empty: origin' requestBody: content: application/json: schema: type: object properties: origin: type: string example: https://example.com description: The website url the API requests will come from ip: type: string nullable: true example: 12.23.34.45 description: The client IP required: - origin "/api/v1/corrections": get: summary: Searches corrections tags: - Corrections description: List corrections operationId: listCorrections security: - token: [] responses: '200': description: Success content: application/json: schema: type: object properties: data: type: array items: "$ref": "#/components/schemas/correction" links: type: object properties: self: type: string description: A link to the current page of the collection first: type: string description: A link to the first page of the collection next: type: string description: A link to the next page of the collection prev: type: string description: A link to the previous page of the collection last: type: string description: A link to the last page of the collection required: - self meta: type: object properties: total: type: integer examples: returns-a-200-response: value: data: - id: 3 record_type: Species record_id: 106648 user_id: 30 warning_type: change_status: pending change_type: update accepted_by: notes: The height is wrong, it's way smaller created_at: '2020-07-22T11:16:32.796Z' updated_at: '2020-07-22T11:16:32.796Z' correction: scientific_name: Arctostaphylos uva-ursi ssp. coloradensis maximum_height_value: 7 maximum_height_unit: cm changes: - id: 4 record_type: Species record_id: 697964 user_id: 31 warning_type: change_status: pending change_type: update accepted_by: notes: Is the author okay ? created_at: '2020-07-22T11:16:32.803Z' updated_at: '2020-07-22T11:16:32.803Z' correction: changes: links: self: "/api/v1/corrections" first: "/api/v1/corrections?page=1" last: "/api/v1/corrections?page=1" meta: total: 2 '401': description: Invalid credentials content: application/json: examples: returns-a-401-response: value: error: true messages: Invalid access token "/api/v1/corrections/{id}": get: summary: Retrieve a correction tags: - Corrections description: Get a correction operationId: getCorrection parameters: - name: id required: true in: path description: The id of the requested correction schema: type: string security: - token: [] responses: '200': description: Success content: application/json: schema: type: object properties: data: "$ref": "#/components/schemas/correction" meta: type: object properties: last_modified: type: string examples: returns-a-200-response: value: data: id: 7 record_type: Species record_id: 106648 user_id: 35 warning_type: change_status: pending change_type: update accepted_by: notes: The height is wrong, it's way smaller created_at: '2020-07-22T11:16:32.864Z' updated_at: '2020-07-22T11:16:32.864Z' correction: scientific_name: Arctostaphylos uva-ursi ssp. coloradensis maximum_height_value: 7 maximum_height_unit: cm changes: meta: last_modified: '2020-07-22T11:16:32.864Z' '401': description: Invalid credentials content: application/json: examples: returns-a-401-response: value: error: true messages: Invalid access token "/api/v1/corrections/species/{record_id}": post: summary: Submit a correction tags: - Corrections description: Submit a new correction for the given species, that will be reviewed and merged into the database. See [Complete our data](/docs/advanced/complete-data) to get started. operationId: createCorrection parameters: - name: record_id required: true in: path description: The id or the slug of the requested correction schema: type: string security: - token: [] responses: '200': description: Success content: application/json: schema: type: object properties: data: "$ref": "#/components/schemas/correction" meta: type: object properties: last_modified: type: string examples: returns-a-200-response: value: data: id: 13 record_type: Species record_id: 1164724 user_id: 42 warning_type: change_status: pending change_type: update accepted_by: notes: This tree can grows up to 68 meters created_at: '2020-07-22T11:16:32.992Z' updated_at: '2020-07-22T11:16:32.992Z' correction: maximum_height_value: 6800 maximum_height_unit: cm scientific_name: Abies alba changes: maximum_height_cm: - 5000 - 6800 meta: last_modified: '2020-07-22T11:16:32.992Z' '422': description: Invalid parameters content: application/json: examples: returns-a-422-response: value: error: true message: No correction has been submitted '401': description: Invalid credentials content: application/json: examples: returns-a-401-response: value: error: true messages: Invalid access token requestBody: content: application/json: schema: "$ref": "#/components/schemas/request_body_correction" components: securitySchemes: bearerAuth: type: http scheme: bearer bearerFormat: JWT token: type: apiKey name: token in: query schemas: kingdom: type: object properties: id: type: integer name: type: string slug: type: string links: type: object properties: self: type: string required: - self required: - id - name - slug - links subkingdom: type: object properties: id: type: integer name: type: string slug: type: string kingdom: "$ref": "#/components/schemas/kingdom" links: type: object properties: self: type: string kingdom: type: string required: - self - kingdom required: - id - name - slug - links - kingdom division: type: object properties: id: type: integer name: type: string slug: type: string subkingdom: "$ref": "#/components/schemas/subkingdom" links: type: object properties: self: type: string subkingdom: type: string required: - self - subkingdom required: - id - name - slug - links - subkingdom division_class: type: object properties: id: type: integer name: type: string slug: type: string division: "$ref": "#/components/schemas/division" links: type: object properties: self: type: string division: type: string required: - self required: - id - name - slug - links division_order: type: object properties: id: type: integer name: type: string slug: type: string division_class: "$ref": "#/components/schemas/division_class" links: type: object properties: self: type: string division_class: type: string required: - self required: - id - name - slug - links family: type: object properties: id: type: integer name: type: string common_name: type: string nullable: true slug: type: string division_order: "$ref": "#/components/schemas/division_order" links: type: object properties: self: type: string division_order: type: string required: - self required: - id - name - slug - links genus: type: object properties: id: type: integer name: type: string slug: type: string family: "$ref": "#/components/schemas/family" links: type: object properties: self: type: string family: type: string required: - self required: - id - name - slug - links plant: type: object properties: id: type: integer common_name: type: string nullable: true slug: type: string scientific_name: type: string year: type: integer nullable: true bibliography: type: string nullable: true author: type: string nullable: true family_common_name: type: string nullable: true genus_id: type: integer main_species_id: type: integer nullable: true vegetable: type: boolean nullable: true observations: type: string nullable: true main_species: "$ref": "#/components/schemas/species" sources: type: array items: "$ref": "#/components/schemas/source" links: type: object properties: self: type: string genus: type: string species: type: string required: - self - genus - species required: - id - scientific_name - slug - links plant_light: type: object properties: id: type: integer common_name: type: string nullable: true slug: type: string scientific_name: type: string year: type: integer nullable: true bibliography: type: string nullable: true author: type: string nullable: true family_common_name: type: string nullable: true genus_id: type: integer main_species_id: type: integer nullable: true vegetable: type: boolean nullable: true observations: type: string nullable: true links: type: object properties: self: type: string genus: type: string species: type: string required: - self - genus - species required: - id - scientific_name - slug - links species: type: object properties: id: type: integer description: An unique identifier common_name: type: string nullable: true description: The usual common name, in english, of the species (if any). slug: type: string description: An unique human-readable identifier (if you can, prefer to use this over id) scientific_name: type: string description: The scientific name follows the [Binomial nomenclature](https://en.wikipedia.org/wiki/Binomial_nomenclature), and represents its genus and its species within the genus, resulting in a single worldwide name for each organism. The scientific name of an infraspecific taxons (ranks below species, such as subspecies, forms, varieties...) is a combination of the name of a species and an infraspecific epithet. A connecting term is used to denote the rank. [See IAPT recommendation](https://www.iapt-taxon.org/nomen/pages/main/art_24.html) year: type: integer nullable: true description: The first publication year of a valid name of this species. [See author citation](https://en.wikipedia.org/wiki/Author_citation_(botany)) bibliography: type: string nullable: true description: The first publication of a valid name of this species. [See author citation](https://en.wikipedia.org/wiki/Author_citation_(botany)) author: type: string nullable: true description: The author(s) of the first publication of a valid name of this species. [See author citation](https://en.wikipedia.org/wiki/Author_citation_(botany)) status: type: string enum: - accepted - unknown - description: The acceptance status of this species by IPNI rank: type: string enum: - species - ssp - var - form - hybrid - subvar - description: The [taxonomic rank](https://en.wikipedia.org/wiki/Taxonomic_rank) of the species family_common_name: type: string nullable: true description: The common name (in english) of the species family family: type: string description: The scientific name of the species family genus_id: type: integer description: The id of the species genus genus: type: string description: The scientific name of the species genus image_url: type: string nullable: true description: A main image url of the species links: type: object properties: self: type: string description: API endpoint to the species itself genus: type: string description: API endpoint to the species genus plant: type: string description: API endpoint to the species plant required: - self - genus - plant description: API endpoints to related resources duration: type: array nullable: true items: type: string nullable: true enum: - annual - biennial - perennial - description: | The plant duration(s), which can be: - Annual: plants that live, reproduce, and die in one growing season. - Biennial: plants that need two growing seasons to complete their life cycle, normally completing vegetative growth the first year and flowering the second year. - Perennial: plants that live for more than two years, with the shoot system dying back to soil level each year. description: | The plant duration(s), which can be: - Annual: plants that live, reproduce, and die in one growing season. - Biennial: plants that need two growing seasons to complete their life cycle, normally completing vegetative growth the first year and flowering the second year. - Perennial: plants that live for more than two years, with the shoot system dying back to soil level each year. observations: type: string nullable: true description: Some habit observations on the species images: type: object properties: flower: type: array items: type: object properties: id: type: integer description: An unique identifier image_url: type: string description: The url of the image copyright: type: string nullable: true description: A copyright (if any) for the image. Don't forget to properly credit the author if you're using them description: Image(s) of the species flower leaf: type: array items: type: object properties: id: type: integer description: An unique identifier image_url: type: string description: The url of the image copyright: type: string nullable: true description: A copyright (if any) for the image. Don't forget to properly credit the author if you're using them description: Image(s) of the species leaf habit: type: array items: type: object properties: id: type: integer description: An unique identifier image_url: type: string description: The url of the image copyright: type: string nullable: true description: A copyright (if any) for the image. Don't forget to properly credit the author if you're using them description: Image(s) of the species habit fruit: type: array items: type: object properties: id: type: integer description: An unique identifier image_url: type: string description: The url of the image copyright: type: string nullable: true description: A copyright (if any) for the image. Don't forget to properly credit the author if you're using them description: Image(s) of the species fruit bark: type: array items: type: object properties: id: type: integer description: An unique identifier image_url: type: string description: The url of the image copyright: type: string nullable: true description: A copyright (if any) for the image. Don't forget to properly credit the author if you're using them description: Image(s) of the species bark other: type: array items: type: object properties: id: type: integer description: An unique identifier image_url: type: string description: The url of the image copyright: type: string nullable: true description: A copyright (if any) for the image. Don't forget to properly credit the author if you're using them description: 'Image(s) of the species other ' common_names: type: object additionalProperties: type: array items: type: string nullable: true description: TODO description: Common names of the species per language distribution: type: object additionalProperties: type: array items: type: string nullable: true description: TODO description: Distribution of the species per establishment flower: type: object properties: color: type: array nullable: true items: type: string nullable: true enum: - white - red - brown - orange - yellow - lime - green - cyan - blue - purple - magenta - grey - black - description: The flower color(s) description: The flower color(s) conspicuous: type: boolean nullable: true description: Is the flower visible ? description: Flower related fields (the reproductive structure found in flowering plants) foliage: type: object properties: texture: type: string nullable: true enum: - fine - medium - coarse - description: The general texture of the plant’s foliage color: type: array nullable: true items: type: string nullable: true enum: - white - red - brown - orange - yellow - lime - green - cyan - blue - purple - magenta - grey - black - description: The leaves color(s) description: The leaves color(s) leaf_retention: type: boolean nullable: true description: Does the leaves stay all year long ? description: Foliage (or leaves) related fields fruit_or_seed: type: object properties: conspicuous: type: boolean nullable: true description: Is the fruit visible ? color: type: array nullable: true items: type: string nullable: true enum: - white - red - brown - orange - yellow - lime - green - cyan - blue - purple - magenta - grey - black - description: The fruit color(s) description: The fruit color(s) shape: type: string nullable: true description: Fruit shape seed_persistence: type: boolean nullable: true description: Are the fruit or seed generally recognized as being persistent on the plant? description: Fruit or seed related fields specifications: type: object properties: ligneous_type: type: string nullable: true enum: - liana - subshrub - shrub - tree - parasite - description: The ligneous type of the woody plant growth_form: type: string nullable: true description: The primary growth form on the landscape in relation to soil stabilization on slopes and streamsides? Each plant species is assigned the single growth form that most enhances its ability to stabilize soil growth_habit: type: string nullable: true description: The general appearance, growth form, or architecture of the plant growth_rate: type: string nullable: true description: The relative growth speed of the plant average_height: type: object properties: cm: type: integer nullable: true description: The average height of the species, in centimeters description: The average height of the species, in centimeters maximum_height: type: object properties: cm: type: integer nullable: true description: The maximum height of the species, in centimeters description: The maximum height of the species, in centimeters nitrogen_fixation: type: string nullable: true description: Capability to fix nitrogen in monoculture shape_and_orientation: type: string nullable: true description: The predominant shape of the species toxicity: type: string nullable: true enum: - none - low - medium - high - description: Relative toxicity of the species for humans or animals description: Species's main characteristics growth: type: object properties: days_to_harvest: type: number nullable: true description: The average numbers of days required to from planting to harvest description: type: string nullable: true description: A description on how the plant usually grows sowing: type: string nullable: true description: A description on how to sow the plant ph_maximum: type: number nullable: true description: The maximum acceptable soil pH (of the top 30 centimeters of soil) for the plant ph_minimum: type: number nullable: true description: The minimum acceptable soil pH (of the top 30 centimeters of soil) for the plant light: type: integer nullable: true description: Required amount of light, on a scale from 0 (no light, <= 10 lux) to 10 (very intensive insolation, >= 100 000 lux) atmospheric_humidity: type: integer nullable: true description: Required relative humidity in the air, on a scale from 0 (<=10%) to 10 (>= 90%) growth_months: type: array nullable: true items: type: string nullable: true enum: - jan - feb - mar - apr - may - jun - jul - aug - sep - oct - nov - dec - description: The most active growth months of the species (usually all year round for perennial plants) description: The most active growth months of the species (usually all year round for perennial plants) bloom_months: type: array nullable: true items: type: string nullable: true enum: - jan - feb - mar - apr - may - jun - jul - aug - sep - oct - nov - dec - description: The months the species usually blooms description: The months the species usually blooms fruit_months: type: array nullable: true items: type: string nullable: true enum: - jan - feb - mar - apr - may - jun - jul - aug - sep - oct - nov - dec - description: The months the species usually produces fruits description: The months the species usually produces fruits row_spacing: type: object properties: cm: type: number nullable: true description: The minimum spacing between each rows of plants, in centimeters description: The minimum spacing between each rows of plants, in centimeters spread: type: object properties: cm: type: number nullable: true description: The average spreading of the plant, in centimeters description: The average spreading of the plant, in centimeters minimum_precipitation: type: object properties: mm: type: number nullable: true description: Minimum precipitation per year, in milimeters per year description: Minimum precipitation per year, in milimeters per year maximum_precipitation: type: object properties: mm: type: number nullable: true description: Maximum precipitation per year, in milimeters per year description: Maximum precipitation per year, in milimeters per year minimum_root_depth: type: object properties: cm: type: number nullable: true description: Minimum depth of soil required for the species, in centimeters. Plants that do not have roots such as rootless aquatic plants have 0 description: Minimum depth of soil required for the species, in centimeters. Plants that do not have roots such as rootless aquatic plants have 0 minimum_temperature: type: object properties: deg_f: type: number nullable: true description: The minimum tolerable temperature for the species. In fahrenheit degrees deg_c: type: number nullable: true description: The minimum tolerable temperature for the species. In celsius degrees description: The minimum tolerable temperature for the species. In celsius or fahrenheit degrees maximum_temperature: type: object properties: deg_f: type: number nullable: true description: The maximum tolerable temperature for the species. In fahrenheit degrees deg_c: type: number nullable: true description: The maximum tolerable temperature for the species. In celsius degrees description: The maximum tolerable temperature for the species. In celsius or fahrenheit degrees soil_nutriments: type: integer nullable: true description: Required quantity of nutriments in the soil, on a scale from 0 (oligotrophic) to 10 (hypereutrophic) soil_salinity: type: integer nullable: true description: Tolerance to salinity, on a scale from 0 (untolerant) to 10 (hyperhaline) soil_texture: type: integer nullable: true description: Required texture of the soil, on a scale from 0 (clay) to 10 (rock) soil_humidity: type: integer nullable: true description: Required humidity of the soil, on a scale from 0 (xerophile) to 10 (subaquatic) description: Growing of farming related fields synonyms: type: array items: type: object properties: id: type: integer description: An unique identifier name: type: string description: The scientific name of the symonym author: type: string nullable: true description: The author of the symonym description: The symonyms scientific names and authors sources: type: array items: type: object properties: id: type: string description: An unique identifier from the source name: type: string description: The name of the source citation: type: string description: How to cite the source url: type: string description: The link on the source website, or the publication reference last_update: type: string description: The last time the source was checked description: The symonyms scientific names and authors extras: description: '' required: - id - scientific_name - slug species_light: type: object properties: id: type: integer description: An unique identifier common_name: type: string nullable: true description: The usual common name, in english, of the species (if any). slug: type: string description: An unique human-readable identifier (if you can, prefer to use this over id) scientific_name: type: string description: The scientific name follows the [Binomial nomenclature](https://en.wikipedia.org/wiki/Binomial_nomenclature), and represents its genus and its species within the genus, resulting in a single worldwide name for each organism. The scientific name of an infraspecific taxons (ranks below species, such as subspecies, forms, varieties...) is a combination of the name of a species and an infraspecific epithet. A connecting term is used to denote the rank. [See IAPT recommendation](https://www.iapt-taxon.org/nomen/pages/main/art_24.html) year: type: integer nullable: true description: The first publication year of a valid name of this species. [See author citation](https://en.wikipedia.org/wiki/Author_citation_(botany)) bibliography: type: string nullable: true description: The first publication of a valid name of this species. [See author citation](https://en.wikipedia.org/wiki/Author_citation_(botany)) author: type: string nullable: true description: The author(s) of the first publication of a valid name of this species. [See author citation](https://en.wikipedia.org/wiki/Author_citation_(botany)) status: type: string enum: - accepted - unknown - description: The acceptance status of this species by IPNI rank: type: string enum: - species - ssp - var - form - hybrid - subvar - description: The [taxonomic rank](https://en.wikipedia.org/wiki/Taxonomic_rank) of the species family_common_name: type: string nullable: true description: The common name (in english) of the species family family: type: string description: The scientific name of the species family genus_id: type: integer description: The id of the species genus genus: type: string description: The scientific name of the species genus image_url: type: string nullable: true description: A main image url of the species links: type: object properties: self: type: string description: API endpoint to the species itself genus: type: string description: API endpoint to the species genus plant: type: string description: API endpoint to the species plant required: - self - genus - plant description: API endpoints to related resources synonyms: type: array items: type: string nullable: true description: TODO description: The symonyms scientific names required: - id - rank - family - genus - genus_id - scientific_name - slug - status - links description: The symonyms scientific names source: type: object properties: id: type: string nullable: true name: type: string url: type: string nullable: true last_update: type: string citation: type: string nullable: true required: - name - last_update correction: type: object properties: id: type: integer accepted_by: type: string nullable: true change_notes: type: string nullable: true change_status: type: string change_type: type: string correction: type: object nullable: true created_at: type: string notes: type: string nullable: true record_id: type: integer nullable: true record_type: type: string updated_at: type: string user_id: type: integer warning_type: type: string nullable: true required: - id - user_id - record_type - updated_at - created_at - change_type - change_status zone: type: object properties: id: type: integer name: type: string slug: type: string tdwg_code: type: string tdwg_level: type: integer species_count: type: integer links: type: object properties: self: type: string plants: type: string species: type: string required: - self - plants - species required: - id - name - slug - links - tdwg_code - tdwg_level - species_count request_body_correction: type: object properties: notes: type: string nullable: true description: Some optional notes you can add. They will be visible to everybody source_type: type: string enum: - external - observation - report - nullable: true description: Where does this data come from ? If "external", you'll need to provide the "source_reference" field with the url or the name of the source, such as a wikipedia article, a publication, etc... source_reference: type: string nullable: true description: The url of the name of an article or a publication for theses changes correction: type: object properties: scientific_name: type: string example: Abelmoschus nonexistus rank: type: string enum: - species - ssp - var - form - hybrid - subvar - example: species genus: type: string nullable: true example: Puya year: type: integer nullable: true example: author: type: string nullable: true example: Moench bibliography: type: string nullable: true example: common_name: type: string nullable: true description: The species common name(s) in english. Several values can be separated with "|" example: Okra|Bonnie Green Okra observations: type: string nullable: true example: Vegetal flavour, Medium-yellow flowers planting_description: type: string nullable: true description: A description on how the plant usually grows planting_sowing_description: type: string nullable: true example: A description on how to sow the plant duration: type: string enum: - annual - biennial - perennial - nullable: true description: The duration(s) of the species. Several values can be separated with "|" example: annual flower_color: type: string enum: - white - red - brown - orange - yellow - lime - green - cyan - blue - purple - magenta - grey - black - nullable: true description: The species flower color(s). Several values can be separated with "|" example: yellow flower_conspicuous: type: boolean nullable: true example: true foliage_color: type: string enum: - white - red - brown - orange - yellow - lime - green - cyan - blue - purple - magenta - grey - black - nullable: true description: The species foliage color(s). Several values can be separated with "|" example: green|blue foliage_texture: type: string enum: - fine - medium - coarse - nullable: true example: leaf_retention: type: boolean nullable: true example: false fruit_color: type: string enum: - white - red - brown - orange - yellow - lime - green - cyan - blue - purple - magenta - grey - black - nullable: true description: The species fruit color(s). Several values can be separated with "|" example: white fruit_conspicuous: type: boolean nullable: true example: false fruit_seed_persistence: type: boolean nullable: true example: false fruit_months: type: string enum: - jan - feb - mar - apr - may - jun - jul - aug - sep - oct - nov - dec - nullable: true description: The months when his species have fruits. Several values can be separated by "|" example: jan|feb|mar bloom_months: type: string enum: - jan - feb - mar - apr - may - jun - jul - aug - sep - oct - nov - dec - nullable: true description: The months when this species blooms. Several values can be separated by "|" example: ground_humidity: type: integer nullable: true description: Required humidity of the soil, on a scale from 0 (xerophile) to 10 (subaquatic) example: growth_form: type: string nullable: true example: growth_habit: type: string nullable: true example: growth_months: type: string enum: - jan - feb - mar - apr - may - jun - jul - aug - sep - oct - nov - dec - nullable: true description: The months when this species grows. Several values can be separated by "|" example: growth_rate: type: string nullable: true example: edible_part: type: string enum: - roots - stem - leaves - flowers - fruits - seeds - nullable: true description: The edible part of the species (if any). Several values can be separated by "|" example: flowers vegetable: type: boolean nullable: true example: false light: type: integer nullable: true description: Required amount of light, on a scale from 0 (no light, <= 10 lux) to 10 (very intensive insolation, >= 100 000 lux) example: 8 atmospheric_humidity: type: integer nullable: true description: Required relative humidity in the air, on a scale from 0 (<=10%) to 10 (>= 90%) example: 3 adapted_to_coarse_textured_soils: type: string nullable: true example: adapted_to_fine_textured_soils: type: string nullable: true example: adapted_to_medium_textured_soils: type: string nullable: true example: anaerobic_tolerance: type: string nullable: true example: average_height_unit: type: string enum: - in - ft - cm - m nullable: true example: cm average_height_value: type: number nullable: true example: '250' maximum_height_unit: type: string enum: - in - ft - cm - m nullable: true example: cm maximum_height_value: type: number nullable: true example: '280' planting_row_spacing_unit: type: string enum: - in - ft - cm - m nullable: true example: cm planting_row_spacing_value: type: number nullable: true example: '80' description: The minimum spacing between each rows of plants planting_spread_unit: type: string enum: - in - ft - cm - m nullable: true example: cm planting_spread_value: type: number nullable: true example: '100' description: The average spreading of the plant planting_days_to_harvest: type: integer nullable: true example: 120 maximum_precipitation_unit: type: string enum: - in - ft - mm - cm - m nullable: true example: mm maximum_precipitation_value: type: number nullable: true example: '2230' minimum_precipitation_unit: type: string enum: - in - ft - mm - cm - m nullable: true example: mm minimum_precipitation_value: type: number nullable: true example: '1300' minimum_root_depth_unit: type: string enum: - in - ft - cm - m nullable: true example: cm minimum_root_depth_value: type: number nullable: true example: '30' ph_maximum: type: number nullable: true example: ph_minimum: type: number nullable: true example: soil_nutriments: type: integer nullable: true description: Required quantity of nutriments in the soil, on a scale from 0 (oligotrophic) to 10 (hypereutrophic) soil_salinity: type: integer nullable: true description: Tolerance to salinity, on a scale from 0 (untolerant) to 10 (hyperhaline) minimum_temperature_deg_c: type: number nullable: true example: 5 description: The minimum required temperature in celcius degrees maximum_temperature_deg_c: type: number nullable: true example: 20 description: The maximum required temperature in celcius degrees soil_texture: type: integer description: Required texture of the soil, on a scale from 0 (clay) to 10 (rock) nullable: true example: ligneous_type: type: string enum: - liana - subshrub - shrub - tree - parasite - nullable: true example: toxicity: type: string enum: - none - low - medium - high - nullable: true example: required: - scientific_name description: The fields to correct filters_families: type: object properties: name: type: string slug: type: string filters_genus: type: object properties: name: type: string slug: type: string family_id: type: string filters_plants: type: object properties: author: type: string bloom_months: type: string common_name: type: string duration: type: string family_common_name: type: string flower_conspicuous: type: string foliage_texture: type: string fruit_conspicuous: type: string fruit_seed_persistence: type: string growth_form: type: string growth_habit: type: string growth_rate: type: string leaf_retention: type: string lifespan: type: string ligneous_type: type: string rank: type: string scientific_name: type: string status: type: string vegetable: type: string growth_months: type: string fruit_months: type: string flower_color: type: string foliage_color: type: string fruit_color: type: string edible_part: type: string establishment: type: string filters_species: type: object properties: author: type: string bloom_months: type: string common_name: type: string duration: type: string family_common_name: type: string flower_conspicuous: type: string foliage_texture: type: string fruit_conspicuous: type: string fruit_seed_persistence: type: string growth_form: type: string growth_habit: type: string growth_rate: type: string leaf_retention: type: string lifespan: type: string ligneous_type: type: string rank: type: string scientific_name: type: string status: type: string vegetable: type: string growth_months: type: string fruit_months: type: string flower_color: type: string foliage_color: type: string fruit_color: type: string edible_part: type: string establishment: type: string filters_not_species: type: object properties: image_url: type: string author: type: string average_height_cm: type: string bibliography: type: string common_name: type: string edible_part: type: string family_common_name: type: string flower_color: type: string flower_conspicuous: type: string foliage_color: type: string foliage_texture: type: string frost_free_days_minimum: type: string fruit_color: type: string fruit_conspicuous: type: string fruit_seed_persistence: type: string ground_humidity: type: string growth_form: type: string growth_habit: type: string growth_rate: type: string images_count: type: string leaf_retention: type: string lifespan: type: string light: type: string ligneous_type: type: string maximum_height_cm: type: string maximum_precipitation_mm: type: string maximum_temperature_deg_c: type: string maximum_temperature_deg_f: type: string minimum_precipitation_mm: type: string minimum_root_depth_cm: type: string minimum_temperature_deg_c: type: string minimum_temperature_deg_f: type: string ph_maximum: type: string ph_minimum: type: string planting_days_to_harvest: type: string planting_row_spacing_cm: type: string planting_spread_cm: type: string rank: type: string scientific_name: type: string soil_nutriments: type: string soil_salinity: type: string soil_texture: type: string status: type: string synonyms_count: type: string sources_count: type: string toxicity: type: string vegetable: type: string year: type: string sorts_families: type: object properties: name: type: string slug: type: string sorts_genus: type: object properties: name: type: string slug: type: string family_id: type: string sorts_plants: type: object properties: atmospheric_humidity: type: string author: type: string average_height_cm: type: string bibliography: type: string common_name: type: string duration: type: string edible: type: string family_common_name: type: string flower_color: type: string flower_conspicuous: type: string foliage_color: type: string foliage_texture: type: string frost_free_days_minimum: type: string fruit_color: type: string fruit_conspicuous: type: string fruit_seed_persistence: type: string ground_humidity: type: string growth_form: type: string growth_habit: type: string growth_rate: type: string images_count: type: string leaf_retention: type: string lifespan: type: string light: type: string ligneous_type: type: string maximum_height_cm: type: string maximum_precipitation_mm: type: string maximum_temperature_deg_c: type: string maximum_temperature_deg_f: type: string minimum_precipitation_mm: type: string minimum_root_depth_cm: type: string minimum_temperature_deg_c: type: string minimum_temperature_deg_f: type: string ph_maximum: type: string ph_minimum: type: string planting_days_to_harvest: type: string planting_row_spacing_cm: type: string planting_spread_cm: type: string rank: type: string scientific_name: type: string soil_nutriments: type: string soil_salinity: type: string soil_texture: type: string sources_count: type: string status: type: string synonyms_count: type: string toxicity: type: string vegetable: type: string year: type: string sorts_species: type: object properties: atmospheric_humidity: type: string author: type: string average_height_cm: type: string bibliography: type: string common_name: type: string duration: type: string edible: type: string family_common_name: type: string flower_color: type: string flower_conspicuous: type: string foliage_color: type: string foliage_texture: type: string frost_free_days_minimum: type: string fruit_color: type: string fruit_conspicuous: type: string fruit_seed_persistence: type: string ground_humidity: type: string growth_form: type: string growth_habit: type: string growth_rate: type: string images_count: type: string leaf_retention: type: string lifespan: type: string light: type: string ligneous_type: type: string maximum_height_cm: type: string maximum_precipitation_mm: type: string maximum_temperature_deg_c: type: string maximum_temperature_deg_f: type: string minimum_precipitation_mm: type: string minimum_root_depth_cm: type: string minimum_temperature_deg_c: type: string minimum_temperature_deg_f: type: string ph_maximum: type: string ph_minimum: type: string planting_days_to_harvest: type: string planting_row_spacing_cm: type: string planting_spread_cm: type: string rank: type: string scientific_name: type: string soil_nutriments: type: string soil_salinity: type: string soil_texture: type: string sources_count: type: string status: type: string synonyms_count: type: string toxicity: type: string vegetable: type: string year: type: string ranges_plants: type: object properties: atmospheric_humidity: type: string frost_free_days_minimum: type: string ground_humidity: type: string images_count: type: string light: type: string average_height_cm: type: string maximum_height_cm: type: string maximum_precipitation_mm: type: string maximum_temperature_deg_c: type: string maximum_temperature_deg_f: type: string minimum_precipitation_mm: type: string minimum_root_depth_cm: type: string minimum_temperature_deg_c: type: string minimum_temperature_deg_f: type: string ph_maximum: type: string ph_minimum: type: string planting_days_to_harvest: type: string planting_row_spacing_cm: type: string planting_spread_cm: type: string soil_nutriments: type: string soil_salinity: type: string soil_texture: type: string synonyms_count: type: string sources_count: type: string toxicity: type: string year: type: string ranges_species: type: object properties: atmospheric_humidity: type: string frost_free_days_minimum: type: string ground_humidity: type: string images_count: type: string light: type: string average_height_cm: type: string maximum_height_cm: type: string maximum_precipitation_mm: type: string maximum_temperature_deg_c: type: string maximum_temperature_deg_f: type: string minimum_precipitation_mm: type: string minimum_root_depth_cm: type: string minimum_temperature_deg_c: type: string minimum_temperature_deg_f: type: string ph_maximum: type: string ph_minimum: type: string planting_days_to_harvest: type: string planting_row_spacing_cm: type: string planting_spread_cm: type: string soil_nutriments: type: string soil_salinity: type: string soil_texture: type: string synonyms_count: type: string sources_count: type: string toxicity: type: string year: type: string servers: - url: http://{defaultHost} variables: defaultHost: default: trefle.io