Noosh
Noosh API

The Noosh API is the integration surface behind Noosh's marketing-execution platform — the API Noosh's own partners page credits for "over 60 integrations to enterprise software systems". It is published as a Swagger 2.0 document with 86 paths and 107 operations across 25 tags: Project, Spec, Spec Template, Estimate, RFE, Rfq, Quote, Order, Shipment, Invoice, File, Task, Time Card, Team Member, Team Member Role, Contact, Country, Exchange Rate, Workgroup, Workgroup Members, Project Category, Project Status, Deactivation Reason, User Fields and My Info. Everything is scoped to a workgroup — workgroup_id is a path parameter on 105 of the 107 operations — and most resources sit under a project. Authentication is HTTP Basic with no scope model. Four URI-path generations (/v1, /1.1, /1.2 and /3) are served simultaneously with no operation marked deprecated. The API documents no pagination, no idempotency key, no webhooks and no rate limits.
Documentation GitHub OpenAPI
OpenAPI Specification

swagger: '2.0'
info:
  description: Full description of Noosh API
  version: '1.0'
  title: Noosh API application
  contact: {}
  x-api-evangelist-note: Harvested verbatim from https://api.noosh.com/api/swagger.json on 2026-08-13. The published document declares host example.com:80 and basePath /v1, which are build-time placeholders
    (the same document is mirrored by APIs.guru with host noosh.local:80). host has been set to api.noosh.com — the host that actually serves this document and the Swagger UI at /api/developer/index.html
    — and basePath removed because every path already carries its own version prefix (/v1, /1.1, /1.2, /3). The unmodified document is preserved at openapi/_original/noosh-openapi.json. Every route returns
    HTTP 403 to unauthenticated callers (AWS API Gateway + CloudFront), so the deployment path prefix could not be confirmed live.
host: api.noosh.com
tags:
- name: Contact
- name: Country
- name: Deactivation Reason
- name: Estimate
- name: Exchange Rate
- name: File
- name: Invoice
- name: My Info
- name: Order
- name: Project
- name: Project Category
- name: Project Status
- name: Quote
- name: RFE
- name: Rfq
- name: Shipment
- name: Spec
- name: Spec Template
- name: Task
- name: Team Member
- name: Team Member Role
- name: Time Card
- name: User Fields
- name: Workgroup
- name: Workgroup Members
schemes:
- https
paths:
  /1.1/workgroups/{workgroup_id}/projects/{project_id}/fileTags:
    get:
      tags:
      - File
      summary: List Tags from Workgroup and Project.
      description: List Tags from Workgroup and Project.
      operationId: getFileTags
      consumes: []
      produces:
      - application/json
      - application/x-json-smile
      - application/xml
      - text/xml
      - application/x-yaml
      - text/x-yaml
      - text/csv
      - '*/*'
      parameters:
      - name: workgroup_id
        in: path
        required: true
        type: string
      - name: project_id
        in: path
        required: true
        type: string
      responses:
        '200':
          description: Successful retrieval
          schema:
            $ref: '#/definitions/FileTagResponseVO'
        '500':
          description: Internal server error
          schema:
            $ref: '#/definitions/HTTPStatusVO'
  /1.1/workgroups/{workgroup_id}/projects/{project_id}/files:
    get:
      tags:
      - File
      summary: List Files from Project.  Works for Regular and Remote Files
      description: List Files from Project.  Works for Regular and Remote Files
      operationId: getFiles
      consumes: []
      produces:
      - application/json
      - application/x-json-smile
      - application/xml
      - text/xml
      - application/x-yaml
      - text/x-yaml
      - text/csv
      - '*/*'
      parameters:
      - name: workgroup_id
        in: path
        required: true
        type: string
      - name: project_id
        in: path
        required: true
        type: string
      responses:
        '200':
          description: Successful retrieval
          schema:
            $ref: '#/definitions/FileListResponseVO'
        '500':
          description: Internal server error
          schema:
            $ref: '#/definitions/HTTPStatusVO'
    post:
      tags:
      - File
      summary: Upload File to Project. <br /> A multipart/form-data request that accepts 2 values. "file" and "tags" <br /> file = {the
      description: 'Upload File to Project. <br /> A multipart/form-data request that accepts 2 values. "file" and "tags" <br /> file = {the file} <br /> tags = {json string}, examples: <br /> [{"tagName":"aa","isSpec":false}],
        Create or Use existing tag, lookup done by name <br /> [{"tagId":9458887,"isSpec":true}], Existing Spec Tag <br /> [{"tagId":5003785,"isSpec":false}], Existing Tag'
      operationId: uploadFile
      consumes:
      - multipart/form-data
      produces:
      - application/json
      - application/x-json-smile
      - application/xml
      - text/xml
      - application/x-yaml
      - text/x-yaml
      - text/csv
      - '*/*'
      parameters:
      - name: workgroup_id
        in: path
        required: true
        type: string
      - name: project_id
        in: path
        required: true
        type: string
      - in: body
        name: body
        required: false
        schema:
          type: file
      responses:
        '200':
          description: Successful retrieval
          schema:
            $ref: '#/definitions/FileResponseVO'
        '500':
          description: Internal server error
          schema:
            $ref: '#/definitions/HTTPStatusVO'
  /1.1/workgroups/{workgroup_id}/projects/{project_id}/files/{file_id}:
    get:
      tags:
      - File
      summary: Get File from Project.  Works for Regular and Remote Files
      description: Get File from Project.  Works for Regular and Remote Files
      operationId: getFile
      consumes: []
      produces:
      - application/json
      - application/x-json-smile
      - application/xml
      - text/xml
      - application/x-yaml
      - text/x-yaml
      - text/csv
      - '*/*'
      parameters:
      - name: workgroup_id
        in: path
        required: true
        type: string
      - name: project_id
        in: path
        required: true
        type: string
      - name: file_id
        in: path
        required: true
        type: string
      responses:
        '200':
          description: Successful retrieval
          schema:
            $ref: '#/definitions/FileResponseVO'
        '500':
          description: Internal server error
          schema:
            $ref: '#/definitions/HTTPStatusVO'
  /1.1/workgroups/{workgroup_id}/projects/{project_id}/filesByRole:
    post:
      tags:
      - File
      summary: Upload File to Project. <br /> A multipart/form-data request that accepts 2 values. "file" and "tags" <br /> file = {the
      description: 'Upload File to Project. <br /> A multipart/form-data request that accepts 2 values. "file" and "tags" <br /> file = {the file} <br /> tags = {json string}, examples: <br /> [{"tagName":"aa","isSpec":false}],
        Create or Use existing tag, lookup done by name <br /> [{"tagId":9458887,"isSpec":true}], Existing Spec Tag <br /> [{"tagId":5003785,"isSpec":false}], Existing Tag'
      operationId: uploadFile
      consumes:
      - multipart/form-data
      produces:
      - application/json
      - application/x-json-smile
      - application/xml
      - text/xml
      - application/x-yaml
      - text/x-yaml
      - text/csv
      - '*/*'
      parameters:
      - name: workgroup_id
        in: path
        required: true
        type: string
      - name: project_id
        in: path
        required: true
        type: string
      - in: body
        name: body
        required: false
        schema:
          type: file
      responses:
        '200':
          description: Successful retrieval
          schema:
            $ref: '#/definitions/FileResponseVO'
        '500':
          description: Internal server error
          schema:
            $ref: '#/definitions/HTTPStatusVO'
  /1.1/workgroups/{workgroup_id}/projects/{project_id}/specs/{spec_id}:
    get:
      tags:
      - Spec
      summary: List a specific spec of project Level
      description: List a specific spec of project Level
      operationId: getSpec
      consumes: []
      produces:
      - application/json
      - application/x-json-smile
      - application/xml
      - text/xml
      - application/x-yaml
      - text/x-yaml
      - text/csv
      - '*/*'
      parameters:
      - name: workgroup_id
        in: path
        required: true
        type: string
      - name: project_id
        in: path
        required: true
        type: string
      - name: spec_id
        in: path
        required: true
        type: string
      responses:
        '200':
          description: Successful retrieval
          schema:
            $ref: '#/definitions/V1x1SpecExpandVO'
        '500':
          description: Internal server error
          schema:
            $ref: '#/definitions/HTTPStatusVO'
        '404':
          description: There are not any result matching your search condition
          schema:
            $ref: '#/definitions/HTTPStatusVO'
    put:
      tags:
      - Spec
      summary: Update a specific Spec
      description: Update a specific Spec
      operationId: putSpec
      consumes:
      - application/json
      - application/x-json-smile
      - application/xml
      - text/xml
      - application/x-yaml
      - text/x-yaml
      - text/csv
      produces:
      - application/json
      - application/x-json-smile
      - application/xml
      - text/xml
      - application/x-yaml
      - text/x-yaml
      - text/csv
      - '*/*'
      parameters:
      - name: workgroup_id
        in: path
        required: true
        type: string
      - name: project_id
        in: path
        required: true
        type: string
      - name: spec_id
        in: path
        required: true
        type: string
      - in: body
        name: body
        required: false
        schema:
          $ref: '#/definitions/V1X1SpecUpdatingPO'
      responses:
        '200':
          description: Successful updated
          schema:
            $ref: '#/definitions/SpecHTTPStatusVO'
        '500':
          description: Internal server error
          schema:
            $ref: '#/definitions/HTTPStatusVO'
        '404':
          description: There are not any result matching your search condition
          schema:
            $ref: '#/definitions/HTTPStatusVO'
  /1.1/workgroups/{workgroup_id}/projects/{project_id}/teammembers:
    post:
      tags:
      - Team Member
      summary: Invite a team member or all the members of team template for the specific project.
      description: Invite a team member or all the members of team template for the specific project.
      operationId: postTeamMemberOfProject
      consumes:
      - application/json
      - application/x-json-smile
      - application/xml
      - text/xml
      - application/x-yaml
      - text/x-yaml
      - text/csv
      produces:
      - application/json
      - application/x-json-smile
      - application/xml
      - text/xml
      - application/x-yaml
      - text/x-yaml
      - text/csv
      - '*/*'
      parameters:
      - name: workgroup_id
        in: path
        required: true
        type: string
      - name: project_id
        in: path
        required: true
        type: string
      - in: body
        name: body
        required: false
        schema:
          $ref: '#/definitions/TeamMemberPO'
      responses:
        '200':
          description: Successful retrieval
          schema:
            $ref: '#/definitions/V1x1InvitedTeamMemberResultsVO'
        '422':
          description: Invalid data
          schema:
            $ref: '#/definitions/HTTPStatusVO'
        '500':
          description: Internal server error
          schema:
            $ref: '#/definitions/HTTPStatusVO'
  /1.1/workgroups/{workgroup_id}/specTypes/{spec_type_id}/specTypeFields:
    get:
      tags:
      - Spec
      summary: Get Spec Type Fields
      description: Get Spec Type Fields
      operationId: getSpecTypeFields
      consumes: []
      produces:
      - application/json
      - application/x-json-smile
      - application/xml
      - text/xml
      - application/x-yaml
      - text/x-yaml
      - text/csv
      - '*/*'
      parameters:
      - name: workgroup_id
        in: path
        required: true
        type: string
      - name: spec_type_id
        in: path
        required: true
        type: string
      responses:
        '200':
          description: Successful retrieval
          schema:
            $ref: '#/definitions/SpecTypeFieldsListVO'
        '500':
          description: Internal server error
          schema:
            $ref: '#/definitions/HTTPStatusVO'
        '404':
          description: There are not any result matching your search condition
          schema:
            $ref: '#/definitions/HTTPStatusVO'
  /1.2/workgroups/{workgroup_id}/projects/{project_id}/filesByRole:
    post:
      tags:
      - File
      summary: 'Upload File to Project With Notification. <br /> A multipart/form-data request that accepts 2 values. "file" and "tags" '
      description: 'Upload File to Project With Notification. <br /> A multipart/form-data request that accepts 2 values. "file" and "tags" <br /> file = {the file} <br /> tags = {json string}, examples:
        <br /> [{"tagName":"aa","isSpec":false}], Create or Use existing tag, lookup done by name <br /> [{"tagId":9458887,"isSpec":true}], Existing Spec Tag <br /> [{"tagId":5003785,"isSpec":false}], Existing
        Tag'
      operationId: uploadFile
      consumes:
      - multipart/form-data
      produces:
      - application/json
      - application/x-json-smile
      - application/xml
      - text/xml
      - application/x-yaml
      - text/x-yaml
      - text/csv
      - '*/*'
      parameters:
      - name: workgroup_id
        in: path
        required: true
        type: string
      - name: project_id
        in: path
        required: true
        type: string
      - in: body
        name: body
        required: false
        schema:
          type: file
      responses:
        '200':
          description: Successful retrieval
          schema:
            $ref: '#/definitions/FileResponseVO'
        '500':
          description: Internal server error
          schema:
            $ref: '#/definitions/HTTPStatusVO'
  /3/workgroups/{workgroup_id}/projects/{project_id}/files:
    post:
      tags:
      - File
      summary: Upload File V3 to Project With Notification
      description: Upload File V3 to Project With Notification
      operationId: uploadFile
      consumes:
      - multipart/form-data
      produces:
      - application/json
      - application/x-json-smile
      - application/xml
      - text/xml
      - application/x-yaml
      - text/x-yaml
      - text/csv
      - '*/*'
      parameters:
      - name: workgroup_id
        in: path
        required: true
        type: string
      - name: project_id
        in: path
        required: true
        type: string
      - in: body
        name: body
        required: false
        schema:
          type: file
      responses:
        '200':
          description: Successful retrieval
          schema:
            $ref: '#/definitions/FileV3ResponseVO'
        '500':
          description: Internal server error
          schema:
            $ref: '#/definitions/HTTPStatusVO'
  /3/workgroups/{workgroup_id}/projects/{project_id}/folders:
    get:
      tags:
      - File
      summary: List all folders under a project
      description: List all folders under a project
      operationId: getFolders
      consumes: []
      produces:
      - application/json
      - application/x-json-smile
      - application/xml
      - text/xml
      - application/x-yaml
      - text/x-yaml
      - text/csv
      - '*/*'
      parameters:
      - name: workgroup_id
        in: path
        required: true
        type: string
      - name: project_id
        in: path
        required: true
        type: string
      responses:
        '200':
          description: Successful retrieval
          schema:
            $ref: '#/definitions/FolderListVO'
        '500':
          description: Internal server error
          schema:
            $ref: '#/definitions/HTTPStatusVO'
    post:
      tags:
      - File
      summary: Create a new folder under a project
      description: Create a new folder under a project
      operationId: createFolder
      consumes:
      - multipart/form-data
      produces:
      - application/json
      - application/x-json-smile
      - application/xml
      - text/xml
      - application/x-yaml
      - text/x-yaml
      - text/csv
      - '*/*'
      parameters:
      - name: workgroup_id
        in: path
        required: true
        type: string
      - name: project_id
        in: path
        required: true
        type: string
      - in: body
        name: body
        required: false
        schema:
          $ref: '#/definitions/FolderPersisitVO'
      responses:
        '200':
          description: Successful retrieval
          schema:
            $ref: '#/definitions/FolderVO'
        '500':
          description: Internal server error
          schema:
            $ref: '#/definitions/HTTPStatusVO'
  /v1/countries:
    get:
      tags:
      - Country
      summary: List all countries
      description: List all countries
      operationId: getCountryList
      consumes: []
      produces:
      - application/json
      - application/x-json-smile
      - application/xml
      - text/xml
      - application/x-yaml
      - text/x-yaml
      - text/csv
      - '*/*'
      parameters: []
      responses:
        '200':
          description: Successful retrieval
          schema:
            $ref: '#/definitions/CountryListVO'
        '500':
          description: Internal server error
          schema:
            $ref: '#/definitions/HTTPStatusVO'
        '404':
          description: There are not any result matching your search condition
          schema:
            $ref: '#/definitions/HTTPStatusVO'
  /v1/workgroups:
    get:
      tags:
      - Workgroup
      summary: List the workgroups
      description: List the workgroups
      operationId: getWorkgroupList
      consumes: []
      produces:
      - application/json
      - application/x-json-smile
      - application/xml
      - text/xml
      - application/x-yaml
      - text/x-yaml
      - text/csv
      - '*/*'
      parameters:
      - name: workgroup_name
        in: query
        description: Workgroup Name
        required: false
        type: string
      - name: workgroup_types
        in: query
        description: 1000001 for Buyer, 1000002 for supplier, 1000003 for agent, 1000004 for Broker/Outsourcer and 1000005 for Partner
        required: false
        type: array
        items:
          type: string
      responses:
        '200':
          description: Successful retrieval
          schema:
            $ref: '#/definitions/WorkgroupListVO'
        '500':
          description: Internal server error
          schema:
            $ref: '#/definitions/HTTPStatusVO'
        '404':
          description: There are not any result matching your search condition
          schema:
            $ref: '#/definitions/HTTPStatusVO'
  /v1/workgroups/{workgroup_id}/automaticInvitations:
    get:
      tags:
      - My Info
      summary: 'List current user''s automatic invitations info '
      description: 'List current user''s automatic invitations info '
      operationId: getAutomaticInvitationList
      consumes: []
      produces:
      - application/json
      - application/x-json-smile
      - application/xml
      - text/xml
      - application/x-yaml
      - text/x-yaml
      - text/csv
      - '*/*'
      parameters:
      - name: workgroup_id
        in: path
        required: true
        type: string
      responses:
        '200':
          description: Successful retrieval
          schema:
            $ref: '#/definitions/AutomaticInvitationsListVO'
        '500':
          description: Internal server error
          schema:
            $ref: '#/definitions/HTTPStatusVO'
  /v1/workgroups/{workgroup_id}/billingRecipients:
    get:
      tags:
      - Contact
      summary: List Billing Recipients
      description: List Billing Recipients
      operationId: getBillingRecipients
      consumes: []
      produces:
      - application/json
      - application/x-json-smile
      - application/xml
      - text/xml
      - application/x-yaml
      - text/x-yaml
      - text/csv
      - '*/*'
      parameters:
      - name: workgroup_id
        in: path
        required: true
        type: string
      responses:
        '200':
          description: Successful retrieval
          schema:
            $ref: '#/definitions/ContactsListVO'
        '500':
          description: Internal server error
          schema:
            $ref: '#/definitions/HTTPStatusVO'
        '404':
          description: There are not any result matching your search condition
          schema:
            $ref: '#/definitions/HTTPStatusVO'
  /v1/workgroups/{workgroup_id}/buyOrders:
    get:
      tags:
      - Order
      summary: List the buy orders of workgroup
      description: List the buy orders of workgroup
      operationId: getBuyOrderListOfWorkgroup
      consumes: []
      produces:
      - application/json
      - application/x-json-smile
      - application/xml
      - text/xml
      - application/x-yaml
      - text/x-yaml
      - text/csv
      - '*/*'
      parameters:
      - name: workgroup_id
        in: path
        required: true
        type: string
      responses:
        '200':
          description: Successful retrieval
          schema:
            $ref: '#/definitions/OrderWorkgroupLevelListVO'
        '500':
          description: Internal server error
          schema:
            $ref: '#/definitions/HTTPStatusVO'
        '404':
          description: There are not any result matching your search condition
          schema:
            $ref: '#/definitions/HTTPStatusVO'
  /v1/workgroups/{workgroup_id}/buyOrders/{order_id}:
    get:
      tags:
      - Order
      summary: Get a specific buy order of workgroup
      description: Get a specific buy order of workgroup
      operationId: getBuyOrderOfWorkgroup
      consumes: []
      produces:
      - application/json
      - application/x-json-smile
      - application/xml
      - text/xml
      - application/x-yaml
      - text/x-yaml
      - text/csv
      - '*/*'
      parameters:
      - name: workgroup_id
        in: path
        required: true
        type: string
      - name: order_id
        in: path
        required: true
        type: string
      responses:
        '200':
          description: Successful retrieval
          schema:
            $ref: '#/definitions/OrderExpandWorkgroupLevelVO'
        '500':
          description: Internal server error
          schema:
            $ref: '#/definitions/HTTPStatusVO'
        '404':
          description: There are not any result matching your search condition
          schema:
            $ref: '#/definitions/HTTPStatusVO'
  /v1/workgroups/{workgroup_id}/clientWorkgroups:
    get:
      tags:
      - Workgroup
      summary: List client workgroups
      description: List client workgroups
      operationId: getClientWorkgroupList
      consumes: []
      produces:
      - application/json
      - application/x-json-smile
      - application/xml
      - text/xml
      - application/x-yaml
      - text/x-yaml
      - text/csv
      - '*/*'
      parameters:
      - name: workgroup_id
        in: path
        required: true
        type: string
      responses:
        '200':
          description: Successful retrieval
          schema:
            $ref: '#/definitions/ClientWorkgroupListVO'
        '500':
          description: Internal server error
          schema:
            $ref: '#/definitions/HTTPStatusVO'
        '404':
          description: There are not any result matching your search condition
          schema:
            $ref: '#/definitions/HTTPStatusVO'
  /v1/workgroups/{workgroup_id}/clientWorkgroups/{client_workgroup_id}:
    get:
      tags:
      - Workgroup
      summary: Get a specific client workgroups
      description: Get a specific client workgroups
      operationId: getSpecificClientWorkgroup
      consumes: []
      produces:
      - application/json
      - application/x-json-smile
      - application/xml
      - text/xml
      - application/x-yaml
      - text/x-yaml
      - text/csv
      - '*/*'
      parameters:
      - name: workgroup_id
        in: path
        required: true
        type: string
      - name: client_workgroup_id
        in: path
        required: true
        type: string
      responses:
        '200':
          description: Successful retrieval
          schema:
            $ref: '#/definitions/ClientWorkgroupExpandVO'
        '500':
          description: Internal server error
          schema:
            $ref: '#/definitions/HTTPStatusVO'
        '404':
          description: There are not any result matching your search condition
          schema:
            $ref: '#/definitions/HTTPStatusVO'
  /v1/workgroups/{workgroup_id}/clientWorkgroups/{client_workgroup_id}/projectCategory:
    get:
      tags:
      - Project Category
      summary: List the project categories of client side
      description: List the project categories of client side
      operationId: getProjectCategoryListOfClient
      consumes: []
      produces:
      - application/json
      - application/x-json-smile
      - application/xml
      - text/xml
      - application/x-yaml
      - text/x-yaml
      - text/csv
      - '*/*'
      parameters:
      - name: workgroup_id
        in: path
        required: true
        type: string
      - name: client_workgroup_id
        in: path
        required: true
        type: string
      responses:
        '200':
          description: Successful retrieval
          schema:
            $ref: '#/definitions/ProjectCategoryListVO'
        '422':
          description: Invalid data
          schema:
            $ref: '#/definitions/HTTPStatusVO'
        '500':
          description: Internal server error
          schema:
            $ref: '#/definitions/HTTPStatusVO'
        '404':
          description: There are not any result matching your search condition
          schema:
            $ref: '#/definitions/HTTPStatusVO'
  /v1/workgroups/{workgroup_id}/clientWorkgroups/{client_workgroup_id}/projectHomeUserFields:
    get:
      tags:
      - User Fields
      summary: List projec home user fields of client workgroup
      description: List projec home user fields of client workgroup
      operationId: getProjectHomeUserFieldListOfClient
      consumes: []
      produces:
      - application/json
      - application/x-json-smile
      - application/xml
      - text/xml
      - application/x-yaml
      - text/x-yaml
      - text/csv
      - '*/*'
      parameters:
      - name: workgroup_id
        in: path
        required: true
        type: string
      - name: client_workgroup_id
        in: path
        required: true
        type: string
      responses:
        '200':
          description: Successful retrieval
          schema:
            $ref: '#/definitions/ProjectHomeUserFieldsListVO'
        '500':
          description: Internal server error
          schema:
            $ref: '#/definitions/HTTPStatusVO'
        '404':
          description: There are not any result matching your search condition
          schema:
            $ref: '#/definitions/HTTPStatusVO'
  /v1/workgroups/{workgroup_id}/clientWorkgroups/{client_workgroup_id}/projectStatus:
    get:
      tags:
      - Project Status
      summary: List the project status of client
      description: List the project status of client
      operationId: getProjectStatusOfClient
      consumes: []
      produces:
      - application/json
      - application/x-json-smile
      - application/xml
      - text/xml
      - application/x-yaml
      - text/x-yaml
      - text/csv
      - '*/*'
      parameters:
      - name: workgroup_id
        in: path
        required: true
        type: string
      - name: client_workgroup_id
        in: path
        required: true
        type: string
      responses:
        '200':
          description: Successful retrieval
          schema:
            $ref: '#/definitions/ProjectStatusListVO'
        '500':
          description: Internal server error
          schema:
            $ref: '#/definitions/HTTPStatusVO'
        '404':
          description: There are not any result matching your search condition
          schema:
            $ref: '#/definitions/HTTPStatusVO'
  /v1/workgroups/{workgroup_id}/contacts:
    get:
      tags:
      - Contact
      summary: List the contacts
      description: List the contacts
      operationId: getContactList
      consumes: []
      produces:
      - application/json
      - application/x-json-smile
      - application/xml
      - text/xml
      - application/x-yaml
      - text/x-yaml
      - text/csv
      - '*/*'
      parameters:
      - name: workgroup_id
        in: path
        required: true
        type: string
      responses:
        '200':
          description: Successful retrieval
          schema:
            $ref: '#/definitions/ContactsListVO'
        '500':
          description: Internal server error
          schema:
            $ref: '#/definitions/HTTPStatusVO'
        '404':
          description: There are not any result matching your search condition
          schema:
            $ref: '#/definitions/HTTPStatusVO'
  /v1/workgroups/{workgroup_id}/contacts/{user_id}:
    get:
      tags:
      - Contact
      summary: Contact Info
      description: Contact Info
      operationId: getContactUserInfo
      consumes: []
      produces:
      - application/json
      - application/x-json-smile
      - application/xml
      - text/xml
      - application/x-yaml
      - text/x-yaml
      - text/csv
      - '*/*'
      parameters:
      - name: workgroup_id
        in: path
        required: true
        type: string
      - name: user_id
        in: path
        required: true
        type: string
      responses:
        '200':
          description: Successful retrieval
          schema:
            $ref: '#/definitions/UserDetailsExpandVO'
        '500':
          description: Internal server error
          schema:
            $ref: '#/definitions/HTTPStatusVO'
        '404':
          description: There are not any result matching your search condition
          schema:
            $ref: '#/definitions/HTTPStatusVO'
  /v1/workgroups/{workgroup_id}/customTaskStatus:
    get:
      tags:
      - Task
      summary: Get custom task status of workgroup level
      description: Get custom task status of workgroup level
      operationId: getWgTaskStatusListOfWorkgroup
      consumes: []
      produces:
      - application/json
      - application/x-json-smile
      - application/xml
      - text/xml
      - application/x-yaml
      - text/x-yaml
      - text/csv
      - '*/*'
      parameters:
      - name: workgroup_id
        in: path
        required: true
        type: string
      responses:
        '200':
          description: Successful retrieval
          schema:
            $ref: '#/definitions/WgTaskStatusListVO'
        '500':
          description: Internal server error
          schema:
            $ref: '#/definitions/HTTPStatusVO'
        '404':
          description: There are not any result matching your search condition
          schema:
            $ref: '#/definitions/HTTPStatusVO'
  /v1/workgroups/{workgroup_id}/customTaskTypes:
    get:
      tags:
      - Task
      summary: Get custom task types of workgroup level
      description: Get custom task types of workgroup level
      operationId: getCustomTaskTypesOfWg
      consumes: []
      produces:
      - application/json
      - application/x-json-smile
      - application/xml
      - text/xml
      - application/x-yaml
      - text/x-yaml
      - text/csv
      - '*/*'
      parameters:
      - name: workgroup_id
        in: path
        required: true
        type: string
      responses:
        '200':
          description: Successful retrieval
          schema:
            $ref: '#/definitions/TaskTypeListVO'
        '500':
          description: Internal server error
          schema:
            $ref: '#/definitions/HTTPStatusVO'
        '404':
          description: There are not any result matching your search condition
          schema:
            $ref: '#/definitions/HTTPStatusVO'
  /v1/workgroups/{workgroup_id}/deactivationReasons:
    get:
      tags:
      - Deactivation Reason
      summary: List all deactivation reasons
      description: List all deactivation reasons
      operationId: getDeactivationReasonList
      consumes: []
      produces:
      - application/json
      - application/x-json-smile
      - application/xml
      - text/xml
      - application/x-yaml
      - text/x-yaml
      - text/csv
      - '*/*'
      parameters:
      - name: workgroup_id
        in: path
        required: true
        type: string
      responses:
        '200':
          description: Successful retrieval
          schema:
            $ref: '#/definitions/DeactivationReaso

# --- truncated at 32 KB (294 KB total) ---
# Full source: https://raw.githubusercontent.com/api-evangelist/noosh/refs/heads/main/openapi/noosh-openapi.yml
Noosh API

Documentation

Specifications

Other Resources

OpenAPI Specification
