Fulcrumpro

Fulcrumpro Material API

The Material API from Fulcrumpro — 4 operation(s) for material.

GitHub OpenAPI

Operations 4

POST /api/materials/activate Activate materials based on ids #
GET /api/materials/{id} Get a material. #
POST /api/v2/materials/get Get a material by id. #
POST /api/materials/list Find materials based on search parameters #

Documentation

📖
Documentation
https://developers.fulcrumpro.com/docs
📖
APIReference
https://developers.fulcrumpro.com/api-schema
📖
GettingStarted
https://developers.fulcrumpro.com/docs

Specifications

⚙
OpenAPI
https://artifacts.apis.io/fulcrumpro/openapi/fulcrumpro-material-api-openapi.yml

Work with this as data

Every API here is available over the APIs.io API and to AI agents over MCP.

MCP server

One button, every client — Claude, Cursor, VS Code and the rest.

https://apis.io/mcp

Tools for apis

7 MCP tools reach this
  • find_apisBrowse and filter every API in the catalog.
  • get_api_artifactsOne API's artifacts, grouped by type.
  • get_openapiThe primary OpenAPI for this API.
  • find_similar_apisAPIs that look like this one.
  • apis_io_searchSTART HERE — APIs, providers and tags for one query, each with its total.
  • resolveTurn a domain, URL or GitHub org into the provider it belongs to.
  • find_cohortsEvery scored population of providers in the catalog.
All 92 tools →

Call it yourself

curl for this page
This API 
curl "https://apis.io/api/v1/apis/fulcrumpro:fulcrumpro-material-api"
All apis 
curl "https://apis.io/api/v1/apis?limit=25"

Discovery needs no key. Ratings and market analysis are Pro.

Get an API key

Free tier, no form to fill in. Signing in shares your email address with us — we store it to create your key and to recognise you if you sign in with another provider. See our Privacy Policy and Terms.

GitHub Google LinkedIn

A second provider on the same verified email joins the account you already have.

OpenAPI Specification

fulcrumpro-material-api-openapi.yml Raw ↑ 
openapi: 3.2.0
info:
  title: Fulcrum Public Material API
  version: v1
servers:
- url: https://api.fulcrumpro.com
tags:
- name: Material
paths:
  /api/materials/activate:
    post:
      tags:
      - Material
      summary: Activate materials based on ids
      operationId: ActivateMaterial
      requestBody:
        content:
          application/json-patch+json:
            schema:
              $ref: '#/components/schemas/MaterialRequestActivateMaterials'
          application/json:
            schema:
              $ref: '#/components/schemas/MaterialRequestActivateMaterials'
          text/json:
            schema:
              $ref: '#/components/schemas/MaterialRequestActivateMaterials'
          application/*+json:
            schema:
              $ref: '#/components/schemas/MaterialRequestActivateMaterials'
        required: true
      responses:
        '200':
          description: Activated of materials
          content:
            application/json:
              schema:
                type: array
                items:
                  $ref: '#/components/schemas/MaterialShapeDto'
            application/problem+json:
              schema:
                type: array
                items:
                  $ref: '#/components/schemas/MaterialShapeDto'
      x-c4-exposed: true
      x-c4-mutation: true
      x-c4-required-permissions:
      - ItemsAndInventory-Items-Edit Item
  /api/materials/{id}:
    get:
      tags:
      - Material
      summary: Get a material.
      operationId: GetMaterial
      parameters:
      - name: id
        in: path
        required: true
        schema:
          minLength: 1
          type: string
      responses:
        '200':
          description: The material for the given id
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/MaterialShapeDto'
            application/problem+json:
              schema:
                $ref: '#/components/schemas/MaterialShapeDto'
        '404':
          description: Material did not exist
      deprecated: true
  /api/v2/materials/get:
    post:
      tags:
      - Material
      summary: Get a material by id.
      operationId: GetMaterialV2
      requestBody:
        content:
          application/json-patch+json:
            schema:
              $ref: '#/components/schemas/MaterialRequestGetMaterialRequestDto'
          application/json:
            schema:
              $ref: '#/components/schemas/MaterialRequestGetMaterialRequestDto'
          text/json:
            schema:
              $ref: '#/components/schemas/MaterialRequestGetMaterialRequestDto'
          application/*+json:
            schema:
              $ref: '#/components/schemas/MaterialRequestGetMaterialRequestDto'
        required: true
      responses:
        '200':
          description: The material for the given id
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/MaterialShapeDto'
            application/problem+json:
              schema:
                $ref: '#/components/schemas/MaterialShapeDto'
        '404':
          description: Material did not exist
      x-c4-exposed: true
      x-c4-required-permissions:
      - ItemsAndInventory-Items-View Item
  /api/materials/list:
    post:
      tags:
      - Material
      summary: Find materials based on search parameters
      operationId: ListMaterial
      parameters:
      - name: Sort.Field
        in: query
        description: Sort field
        schema:
          minLength: 1
          type: string
      - name: Sort.Dir
        in: query
        description: Sort direction
        schema:
          $ref: '#/components/schemas/CommonEnumSortDirectionEnum'
      - name: Skip
        in: query
        description: 'Number of records to skip. Defaults to 0. Combine with FulcrumProduct.PublicApi.Dto.Common.PagingDto.Take to page

          through a result set larger than one page.'
        schema:
          minimum: 0
          type: integer
          format: int32
      - name: Take
        in: query
        description: 'Number of records to return. Validation accepts 0 through 5000, but `0` is not a

          page size and what an endpoint does with it varies, so send a value from 1 to 5000.


          Two cases differ. A request that supplies paging but leaves this field out takes this

          field''s default of <b>50</b>. A request that supplies no paging at all is

          endpoint-specific — some define their own fallback — so it does not reliably mean any

          particular number of records. Either way the response says nothing about records it

          did not return, so send this explicitly whenever the size of the answer matters.

          Endpoints returning a paged envelope report `totalCount` and `hasNextPage`

          alongside the records; endpoints returning a bare array report neither, so page those

          with FulcrumProduct.PublicApi.Dto.Common.PagingDto.Skip until a page comes back shorter than the value requested.'
        schema:
          maximum: 5000
          minimum: 0
          type: integer
          format: int32
      requestBody:
        content:
          application/json-patch+json:
            schema:
              $ref: '#/components/schemas/MaterialRequestFindParameters'
          application/json:
            schema:
              $ref: '#/components/schemas/MaterialRequestFindParameters'
          text/json:
            schema:
              $ref: '#/components/schemas/MaterialRequestFindParameters'
          application/*+json:
            schema:
              $ref: '#/components/schemas/MaterialRequestFindParameters'
      responses:
        '200':
          description: List of materials matching the filters
          content:
            application/json:
              schema:
                type: array
                items:
                  $ref: '#/components/schemas/MaterialShapeDto'
            application/problem+json:
              schema:
                type: array
                items:
                  $ref: '#/components/schemas/MaterialShapeDto'
      x-c4-exposed: true
      x-c4-required-permissions:
      - ItemsAndInventory-Items-View Item
components:
  schemas:
    MaterialShapeDto:
      required:
      - form
      - id
      - materialReferenceId
      - materialReferenceName
      - name
      - vendors
      type: object
      properties:
        id:
          minLength: 1
          type: string
          description: Unique id associated to this entity.
        active:
          type: boolean
          description: Indicates if this material is activated.
        name:
          maxLength: 200
          minLength: 1
          type: string
          description: Identifying name.
        form:
          $ref: '#/components/schemas/CommonEnumMaterialFormEnum'
        materialReferenceId:
          minLength: 1
          type: string
          description: Material Id
        materialReferenceName:
          maxLength: 200
          minLength: 1
          type: string
          description: Material name
        specification:
          type:
          - string
          - 'null'
          description: Specification
        subSpecification:
          type:
          - string
          - 'null'
          description: Sub-specification
        finish:
          type:
          - string
          - 'null'
          description: Finish
        grade:
          type:
          - string
          - 'null'
          description: Grade
        dimension:
          type:
          - string
          - 'null'
          description: Dimension
        type:
          type:
          - string
          - 'null'
          description: Material type
        version:
          type:
          - string
          - 'null'
          description: Version
        dimensionUnits:
          type:
          - string
          - 'null'
          description: 'Unit the material''s dimensions are in: `Inch`, `Foot`, `Yard`, `Millimeter`, `Centimeter` or `Meter`.

            Routing input-material nesting `d2` and `d3` are costed in this unit. A routing costs from a copy of the material''s

            units, shape type and density taken when the input material was added, so later changes to the material may not reach it.'
        shapeType:
          type:
          - string
          - 'null'
          description: 'How the material is measured: `Planar` (sheet and plate, costed by length and width) or `Linear` (bar, tube and

            structural shapes, costed by length). A nesting''s `d3` applies only to `Planar` materials.'
        linearDensity:
          type:
          - number
          - 'null'
          description: Weight per unit length, in `densityUnits`. Used to cost `Linear` materials.
          format: double
        planarDensity:
          type:
          - number
          - 'null'
          description: Weight per unit area, in `densityUnits`. Used to cost `Planar` materials.
          format: double
        densityUnits:
          type:
          - string
          - 'null'
          description: 'Unit of `linearDensity` and `planarDensity`: `PoundPerFoot`, `KilogramPerMeter`,

            `PoundPerSquareFoot` or `KilogramPerSquareMeter`.

            An input material whose material has no density for its `shapeType` is estimated at zero material cost.'
        vendors:
          type: array
          items:
            $ref: '#/components/schemas/MaterialShapeVendorDto'
          description: Vendors that supply this material.
      additionalProperties: false
      description: Material definition.
    FulcrumProductMaterialsFulcrumLengthUnits:
      enum:
      - inch
      - foot
      - yard
      - millimeter
      - centimeter
      - meter
      type: string
    CommonEnumSortDirectionEnum:
      enum:
      - ascending
      - descending
      type: string
      description: Specify sorting direction.
    MaterialShapeVendorDto:
      required:
      - id
      - isPrimary
      - priceBreaks
      - priceUnit
      - vendorId
      type: object
      properties:
        id:
          type: string
          description: Unique id associated to this entity.
          format: uuid
        vendorId:
          maxLength: 24
          minLength: 24
          type: string
          description: Vendor identifier. Pelase reference /api/vendors endpoint.
        isPrimary:
          type: boolean
          description: Signifies if this is the primary vendor for this material.
        currencyCode:
          type:
          - string
          - 'null'
          description: Currency code/denomination associated to this vendor.
        priceUnit:
          $ref: '#/components/schemas/CommonEnumMaterialVendorPriceUnitEnum'
        leadTimeInDays:
          minimum: 0
          type:
          - integer
          - 'null'
          description: Number of days required between order and receipt
          format: int32
        priceBreaks:
          type: array
          items:
            $ref: '#/components/schemas/MaterialShapeVendorPriceBreakDto'
          description: Vendor price breaks
      additionalProperties: false
      description: Material vendor definition
    CommonEnumMaterialFormEnum:
      enum:
      - sheet
      - plate
      - roundBar
      - flatBar
      - channel
      - squareTube
      - angle
      - treadPlate
      - hexBar
      - squareBar
      - teeBar
      - hBeam
      - rectTube
      - pipe
      - wBeam
      - sBeam
      - roundTube
      - rectBar
      - wideBar
      type: string
      description: Specifies the form of the material.
    MaterialRequestGetMaterialRequestDto:
      required:
      - id
      type: object
      properties:
        id:
          minLength: 1
          type: string
          description: Unique id of the material to retrieve.
      additionalProperties: false
      description: 'Request parameters for looking up a single material by id.

        Introduced for the v2 endpoint because material ids may contain ''/'' characters,

        which cannot be round-tripped through URL path segments.'
    MaterialRequestActivateMaterials:
      required:
      - materialIds
      type: object
      properties:
        materialIds:
          minItems: 1
          type: array
          items:
            type: string
          description: Material ids to activate.
        unit:
          $ref: '#/components/schemas/FulcrumProductMaterialsFulcrumLengthUnits'
      additionalProperties: false
      description: Parameters used for activating materials.
    MaterialShapeVendorPriceBreakDto:
      required:
      - id
      - price
      - quantity
      type: object
      properties:
        id:
          type: string
          description: Unique id associated to this entity.
          format: uuid
        quantity:
          minimum: 0
          type: integer
          description: The minimum quantity to associate this price break to.
          format: int32
        price:
          type: number
          description: The price per unit.
          format: double
      additionalProperties: false
      description: Vendor prices breaks for a material shape.
    CommonEnumMaterialVendorPriceUnitEnum:
      enum:
      - kilogram
      - pound
      type: string
      description: Specifies how a routing input item quantity is measured.
    MaterialRequestFindParameters:
      type: object
      properties:
        ids:
          minItems: 1
          type:
          - array
          - 'null'
          items:
            type: string
          description: Filter materials based on matching ids.
        materials:
          type:
          - array
          - 'null'
          items:
            type: string
          description: Material names.
        grades:
          type:
          - array
          - 'null'
          items:
            type: string
          description: Grades.
        forms:
          type:
          - array
          - 'null'
          items:
            $ref: '#/components/schemas/CommonEnumMaterialFormEnum'
          description: Material forms.
        displayDimensions:
          type:
          - array
          - 'null'
          items:
            type: string
          description: A list of dimension display values to include
        active:
          type:
          - boolean
          - 'null'
          description: Indicate whether to specifically only pull active materials. If left null, all rows are included.
      additionalProperties: false
      description: Parameters used for searching/finding materials.
  securitySchemes:
    bearer:
      type: http
      description: Your API bearer token generated in System Data > Advanced > Public API Setup
      scheme: bearer
      bearerFormat: JWT
x-tagGroups:
- name: Accounting Code
  tags:
  - Accounting Code
- name: Alert
  tags:
  - Alert
- name: Attachment
  tags:
  - Attachment
  - Attachment Certification
- name: Auth
  tags:
  - Auth
- name: CAPAs
  tags:
  - CAPAs
- name: Change Order
  tags:
  - Change Order
- name: Chart Of Accounts
  tags:
  - Chart Of Accounts
- name: Company Info
  tags:
  - Company Info
- name: Custom Field
  tags:
  - Custom Field
- name: Customer
  tags:
  - Customer
  - Customer Address
  - Customer Contact
- name: Customer Tier
  tags:
  - Customer Tier
- name: Department
  tags:
  - Department
- name: Department Shift
  tags:
  - Department Shift
- name: Equipment
  tags:
  - Equipment
- name: Equipment Downtime
  tags:
  - Equipment Downtime
- name: Gauge Code
  tags:
  - Gauge Code
- name: Grade Code
  tags:
  - Grade Code
- name: InProcessTrackingFieldType
  tags:
  - InProcessTrackingFieldType
- name: Inventory
  tags:
  - Inventory
- name: Inventory Event
  tags:
  - Inventory Event
  - Inventory Event Details
- name: Inventory Lot
  tags:
  - Inventory Lot
- name: Inventory Transactions
  tags:
  - Inventory Transactions
- name: Invoice
  tags:
  - Invoice
  - Invoice Deposit Adjustment Line Item
  - Invoice Deposit Line Item
  - Invoice Discount Line Item
  - Invoice Fee Line Item
  - Invoice Line Item
  - Invoice Note
  - Invoice Part Line Item
  - Invoice Refund Line Item
  - Invoice Shipping Charge Line Item
  - Invoice Tax Line Item
- name: Item
  tags:
  - Item
  - Item Custom Fields
  - Item Customer
  - Item Material Vendor
  - Item PriceBreaks
  - Item Routing
  - Item Vendor
- name: Item Category
  tags:
  - Item Category
- name: Item Class
  tags:
  - Item Class
- name: Item Tag
  tags:
  - Item Tag
- name: Job
  tags:
  - Job
  - Job Custom Fields
  - Job Full Routing
  - Job Part Line Item Full Routing
  - Job Item To Make
  - Job Item To Make Operation
  - Job Message
  - Job Operation
- name: Job Tracking Timers
  tags:
  - Job Tracking Timers
- name: Location
  tags:
  - Location
- name: Material
  tags:
  - Material
  - Material Vendor
- name: Material Code
  tags:
  - Material Code
- name: NCRs
  tags:
  - NCRs
- name: Nesting
  tags:
  - Nesting
- name: Note
  tags:
  - Note
- name: Operation
  tags:
  - Operation
- name: Payment Term
  tags:
  - Payment Term
- name: Purchase Order
  tags:
  - Purchase Order
  - Purchase Order Custom Fields
  - Purchase Order Discount Line Item
  - Purchase Order Fee Line Item
  - Purchase Order Line Item
  - Purchase Order Outside Processing Line Item
  - Purchase Order Part Line Item
  - Purchase Order Tax Line Item
  - Purchase Order Vendor Credit Line Item
- name: Quote
  tags:
  - Quote
  - Quote Custom Fields
  - Quote Discount Line Item
  - Quote Fee Line Item
  - Quote Part Line Item
  - Quote Part Line Item Custom Fields
  - Quote Part Line Item Full Routing
  - Quote Tax Line Item
- name: Receiving
  tags:
  - Receiving Receipt
  - Receiving Receipt Line Item
- name: Refund Reason Code
  tags:
  - Refund Reason Code
- name: Reporting
  tags:
  - Reporting
- name: Sales Order
  tags:
  - Sales Order
  - Sales Order Blanket Line Item
  - Sales Order Custom Fields
  - Sales Order Discount Line Item
  - Sales Order Fee Line Item
  - Sales Order Line Item
  - Sales Order Part Line Item
  - Sales Order Part Line Item Custom Fields
  - Sales Order Part Line Item Full Routing
  - Sales Order Refund Line Item
  - Sales Order Shipping Charge Line Item
  - Sales Order Tax Line Item
- name: ScrapReport
  tags:
  - ScrapReport
- name: Settings
  tags:
  - Settings
- name: Shape Code
  tags:
  - Shape Code
- name: Shipment Line Items (V3)
  tags:
  - Shipment Line Items (V3)
- name: Shipment
  tags:
  - Shipment Custom Fields
- name: Shipments
  tags:
  - Shipments
- name: Shipping Method
  tags:
  - Shipping Method
- name: Tag
  tags:
  - Tag
- name: Task
  tags:
  - Task
- name: Tax Rate
  tags:
  - Tax Rate
- name: Time Clock Timers
  tags:
  - Time Clock Timers
- name: Timer
  tags:
  - Timer
- name: Tool
  tags:
  - Tool
- name: Tool Calibration
  tags:
  - Tool Calibration
- name: User
  tags:
  - User
  - User Status
- name: Vendor
  tags:
  - Vendor
  - Vendor Address
  - Vendor Contact
- name: Work Order
  tags:
  - Work Order
- name: WorkCenter
  tags:
  - WorkCenter
x-provenance:
  method: harvested
  publisher: Fulcrumpro
  source: https://api.fulcrumpro.com/swagger/v1/swagger.json
  note: split by refine-openapis from the provider's own published document, verified by fetch (openapi/_original/*.fetch.json);
    stamped by stamp-openapi-provenance.py (roadmap#793)