Skip to content
Bottle

List gas types

GET
/gas-types
curl --request GET \
  --url https://example.com/gas-types \
  --cookie bottle.session_token=<bottle.session_token>

The families cylinders come in: what the trade calls the colour. Sizes swap inside one and never across two. Ordered by name; archived ones are left out unless asked for.

Authorizations

Section titled “Authorizations”

Parameters

Section titled “Parameters”

Query Parameters

Section titled “Query Parameters”
includeArchived

Include retired ones.

string

Include retired ones.

Responses

Section titled “Responses”

200

Section titled “200”

Gas types

Media typeapplication/json
object
items
required
Array<object>
object
id
required

UUID v7

string format: uuid
name
required
string
supplier
required
string | null
colour
required
string | null
/^#[0-9a-fA-F]{6}$/
catalogueKey
required
string | null
archivedAt
required
string | null format: date-time
createdAt
required
string format: date-time
updatedAt
required
string format: date-time
Example
{
  "items": [
    {
      "id": "019205d1-6e7a-7c3b-9f6e-3a2b1c0d9e8f",
      "name": "Flogas Propane",
      "supplier": "Flogas",
      "colour": "#D7263D"
    }
  ]
}

401

Section titled “401”

Not signed in

Media typeapplication/json
object
error
required
string
message
required
string
Example
{
  "error": "not_found",
  "message": "Customer not found"
}

403

Section titled “403”

Not a member, or without the permission this needs

Media typeapplication/json
object
error
required
string
message
required
string
Example
{
  "error": "not_found",
  "message": "Customer not found"
}

422

Section titled “422”

Validation failed

Media typeapplication/json
object
error
required
string
Allowed values: validation
message
required
string
issues
required
Array<object>
object
path
required
string
message
required
string
Example
{
  "error": "validation",
  "issues": [
    {
      "path": "email",
      "message": "Invalid email"
    }
  ]
}