Filaments

List the current user's filaments, paged.

These are the user's filament spools, which the web app calls materials. Use a filament's id in a print's filamentUsage to record what the print consumed. Weights are in milligrams.

get/api/Filaments

Request

  • Base URL: https://api.3dprintlog.com
  • URL: https://api.3dprintlog.com/api/Filaments
  • Auth: one of:
    • OAuth 2 (authorization code, authorization URL https://3dprintlog.auth0.com/authorize, token URL https://3dprintlog.auth0.com/oauth/token)
    • API key in header X-Api-Key
    • API key in query parameter api_key

Query parameters

PageNumberinteger

The 1-based page number for pagination.

PageSizeinteger

The number of items to return per page.

SortDirection1 | 2

Sent as an integer: 1 = Asc, 2 = Desc.

SortColumn1 | 2 | 3 | 4 | 5 | 6

Sent as an integer: 1 = DisplayName, 2 = MaterialType, 3 = FilamentRemaining, 4 = Brand, 5 = Color, 6 = StorageLocation.

searchTextstring

Search filament's name/description/brand for text.

filterByMaterialCategoryNicknamestring

Optional filter by a material category nickname

filterByStorageLocationstring
includeInactiveboolean

Include filament rolls that have been marked as inactive.

showFavoritesOnlyboolean

Show only the favoriate filaments

showLoadedFilamentOnlyboolean

Show only currently loaded filament

colorPatternsPrintLogApiEnumsColorPatternType[]
finishTypesPrintLogApiEnumsFilamentFinishType[]
effectsPrintLogApiEnumsFilamentEffect[]

Response

Returns the paged list of filament rolls.

Changes

No recorded changes to this operation across all 1 revision of this API.