Fulcrumpro User API

openapi: 3.2.0
info:
  title: Fulcrum Public User API
  version: v1
servers:
- url: https://api.fulcrumpro.com
tags:
- name: User
paths:
  /api/users/{userId}:
    get:
      tags:
      - User
      summary: Get a specific user
      operationId: GetUser
      parameters:
      - name: userId
        in: path
        required: true
        schema:
          maxLength: 24
          minLength: 24
          type: string
      responses:
        '200':
          description: The user for the given id
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/UserDto'
            application/problem+json:
              schema:
                $ref: '#/components/schemas/UserDto'
        '404':
          description: User order did not exist
      x-c4-exposed: true
      x-c4-required-permissions:
      - System-Users-View Users
  /api/users/list:
    post:
      tags:
      - User
      summary: Find users based on search parameters
      operationId: ListUser
      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/UserRequestFindParameters'
          application/json:
            schema:
              $ref: '#/components/schemas/UserRequestFindParameters'
          text/json:
            schema:
              $ref: '#/components/schemas/UserRequestFindParameters'
          application/*+json:
            schema:
              $ref: '#/components/schemas/UserRequestFindParameters'
      responses:
        '200':
          description: List of users matching the filters
          content:
            application/json:
              schema:
                type: array
                items:
                  $ref: '#/components/schemas/UserListDto'
            application/problem+json:
              schema:
                type: array
                items:
                  $ref: '#/components/schemas/UserListDto'
      x-c4-exposed: true
      x-c4-required-permissions:
      - System-Users-View Users
components:
  schemas:
    CommonReferenceDto:
      type: object
      properties:
        id:
          maxLength: 24
          minLength: 24
          type:
          - string
          - 'null'
          description: Unique Id associated to the referenced object
        name:
          maxLength: 200
          minLength: 1
          type:
          - string
          - 'null'
          description: Descriptive name associated to the object
      additionalProperties: false
      description: Represents a reference to a document in a DB collection
    CommonEnumSortDirectionEnum:
      enum:
      - ascending
      - descending
      type: string
      description: Specify sorting direction.
    UserDto:
      required:
      - id
      type: object
      properties:
        id:
          maxLength: 24
          minLength: 24
          type: string
          description: Unique id associated to this entity.
        employeeId:
          maxLength: 200
          minLength: 1
          type:
          - string
          - 'null'
          description: This property represents the unique identifier of an employee.
        firstName:
          maxLength: 200
          minLength: 1
          type:
          - string
          - 'null'
          description: First name
        lastName:
          maxLength: 200
          minLength: 1
          type:
          - string
          - 'null'
          description: Last name
        emailAddress:
          type:
          - string
          - 'null'
          description: Email address
          format: email
        phoneNumber:
          type:
          - string
          - 'null'
          description: Email address
        roles:
          type:
          - array
          - 'null'
          items:
            type: string
          description: Roles associated to the user.
        deleted:
          type: boolean
          description: Indicates whether this user has been deleted
      additionalProperties: false
      description: User.
    UserListDto:
      required:
      - id
      type: object
      properties:
        id:
          maxLength: 24
          minLength: 24
          type: string
          description: Unique id associated to this entity.
        employeeId:
          maxLength: 200
          minLength: 1
          type:
          - string
          - 'null'
          description: This property represents the unique identifier of an employee.
        firstName:
          maxLength: 200
          minLength: 1
          type:
          - string
          - 'null'
          description: First name
        lastName:
          maxLength: 200
          minLength: 1
          type:
          - string
          - 'null'
          description: Last name
        emailAddress:
          type:
          - string
          - 'null'
          description: Email address
          format: email
        phoneNumber:
          type:
          - string
          - 'null'
          description: Email address
        roleIds:
          type:
          - array
          - 'null'
          items:
            $ref: '#/components/schemas/CommonReferenceDto'
          description: Roles associated to the user.
        deleted:
          type: boolean
          description: Indicates whether this user has been deleted
      additionalProperties: false
      description: User.
    UserRequestFindParameters:
      type: object
      properties:
        firstName:
          maxLength: 200
          minLength: 1
          type:
          - string
          - 'null'
          description: Filter users based on their first name.
        lastName:
          maxLength: 200
          minLength: 1
          type:
          - string
          - 'null'
          description: Filter users based on their last name.
        emailAddress:
          type:
          - string
          - 'null'
          description: Email address
        phoneNumber:
          type:
          - string
          - 'null'
          description: Phone number
        roles:
          type:
          - array
          - 'null'
          items:
            type: string
          description: Filter users to those with any of the provided roles.
        omniSearch:
          type:
          - string
          - 'null'
          description: Search for users based on a string that should match any of the user's first name, last name, email address, phone number or roles.
        includeDeleted:
          type: boolean
          description: When true, inactive/deleted users are included in the results. Defaults to false, in which case only active users are returned.
      additionalProperties: false
      description: Parameters used for searching/finding users.
  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)