GET /brands
List brands

Supported Formats

json

Errors

Code Description
400 The request was unacceptable, often due to missing a required parameter.

Examples

GET /brands
200
{
  "pagination": {
    "per_page": 25,
    "total_pages": 0,
    "total_objects": 0
  },
  "brands": []
}

Params

Param name Description
page
optional

Validations:

  • Must be Integer.
per_page
optional

Validations:

  • Must be Integer.
name
optional

List brands with names matching the provided string.

Validations:

  • Must be a String
name_like
optional

List brands with names matching, or similar to, the provided string. Slower, but useful for correcting user input.

Validations:

  • Must be a String
approved
optional

Validations:

  • Must be true or false.
pending
optional

Validations:

  • Must be true or false.
in_use
optional

Only return brands that have one or more instrument.

Validations:

  • Must be true or false.
in_serial_lookup
optional

Only return brands that have one or more serial number ranges defined.

Validations:

  • Must be true or false.