List products

GET 
/api/products

Required permissions:

• product.view: allows view of company products.

Here the dedicated support page.

Request

Query Parameters

limit integer

Possible values: <= 100

Default value: 100

The number of items to include in the response.

offset integer

Default value: 0

The offset of the first returned item.

updated_at date-time

Filter items by the updated_at field. This is in ISO 8601 format: YYYY-MM-DDTHH:MM:SSZ.

Examples:

On a date

Filter items updated on a date.

Example: 2024-01-01T20:00:00%2B02:00

Greater than

Filter items updated after a date.

Example: gt:2024-01-01T20:00:00%2B02:00

Lower than

Filter items updated before a date.

Example: lt:2024-01-01T20:00:00%2B02:00

available_from date

Filter items by the available_from field. This follow the YYYY-MM-DD format.

Examples:

On a date

Filter items updated on a date.

Example: 2024-01-01

Greater than

Filter items updated after a date.

Example: gt:2024-01-01

Lower than

Filter items updated before a date.

Example: lt:2024-01-01

available_to date

Filter items by the available_to field. This follow the YYYY-MM-DD format.

Examples:

On a date

Filter items updated on a date.

Example: 2024-01-01

Greater than

Filter items updated after a date.

Example: gt:2024-01-01

Lower than

Filter items updated before a date.

Example: lt:2024-01-01

Header Parameters

Wethod-Company stringrequired

The company you want to interact with

Wethod-Version stringrequired

The API version you want to use

Responses

200

Returns the list of products.

application/json

Schema

Schema

• Array [

id integerrequired

Possible values: >= 1

The unique identifier of the resource

created_at date-timerequired

The date and time when the resource was created

updated_at date-timerequired

The date and time when the resource was last updated

name stringrequired

Possible values: <= 50 characters

The name of the product

description string

Possible values: <= 50 characters

The description of the product

available_from date

The availability start date of the product

available_to date

The availability end date of the product

external_cost floatrequired

The external cost of the product

markup integerrequired

The markup percentage for the product

price float

The final price of the product

• ]

Example (from schema)

[
  {
    "id": 1,
    "created_at": "2025-11-06T09:54:31.647Z",
    "updated_at": "2025-11-06T09:54:31.647Z",
    "name": "Premium Software License",
    "description": "Annual license for premium software features",
    "available_from": "2024-01-01",
    "available_to": "2024-12-31",
    "external_cost": 100.5,
    "markup": 20,
    "price": 120.6
  }
]

400

Validation failed

application/json

Schema

Schema

key string

Error unique key

message string

Human-readable message describing the error

failures

object[]

List of validation errors

Array [

field string

Name of the field causing the error

message string

Human-readable description of the error

]

Example (from schema)

{
  "key": "invalid_data",
  "message": "You provided invalid data. Check 'failures' for details.",
  "failures": [
    {
      "field": "string",
      "message": "string"
    }
  ]
}

401

Unauthorized

application/json

Schema

Schema

key string

Error unique key

message string

Human-readable message describing the error

Example (from schema)

{
  "key": "string",
  "message": "string"
}

403

Forbidden

application/json

Schema

Schema

key string

Error unique key

message string

Human-readable message describing the error

Example (from schema)

{
  "key": "string",
  "message": "string"
}

412

Precondition failed

application/json

Schema

Schema

key string

Error unique key

message string

Human-readable message describing the error

Example (from schema)

{
  "key": "precondition_failure",
  "message": "string"
}

Loading...