List gear

GET

/api/v1/gear

const url = 'http://localhost:8080/api/v1/gear';
const options = {method: 'GET', headers: {Authorization: 'Bearer <token>'}};

try {
  const response = await fetch(url, options);
  const data = await response.json();
  console.log(data);
} catch (error) {
  console.error(error);
}

curl --request GET \
  --url http://localhost:8080/api/v1/gear \
  --header 'Authorization: Bearer <token>'

Lists all gear, active gear first

Authorizations

apiKey

Responses

200

All gear.

application/json

object

gear

required

Array<object>

object

required

string

name

required

string

type

required

string

Allowed values: imported custom

isRetired

required

boolean

distanceInMeter

required

integer

numberOfActivities

required

integer

Example

{
  "gear": [
    {
      "id": "gear-b12659861",
      "name": "Canyon Grail",
      "type": "imported",
      "distanceInMeter": 10500,
      "numberOfActivities": 1
    }
  ]
}

401

The Authorization header was missing, malformed, or did not match the configured key.

application/json

Every error uses this shape.

object

error

required

A stable, machine readable code.

string

Allowed values: invalid_token missing_file unsupported_media_type unsupported_file_type file_too_large import_mode_not_files gpx_not_available not_found method_not_allowed bad_request forbidden internal_error

message

required

string

Examples

invalidToken

{
  "error": "invalid_token",
  "message": "A valid API token is required. Send it in the Authorization header as a Bearer token."
}

Headers

WWW-Authenticate

string