ServiceChannel Attachments API
The Attachments API from ServiceChannel — 28 operation(s) for attachments.
The Attachments API from ServiceChannel — 28 operation(s) for attachments.
Every API here is available over the APIs.io API and to AI agents over MCP.
One button, every client — Claude, Cursor, VS Code and the rest.
https://apis.io/mcp
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.curl "https://apis.io/api/v1/apis/servicechannel-attachments-api"
curl "https://apis.io/api/v1/apis?limit=25"
Discovery needs no key. Ratings and market analysis are Pro.
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.
A second provider on the same verified email joins the account you already have.
openapi: 3.2.0
info:
version: bearer.v1
title: Fixxbook.Bearer.Api.V1 AfterHours Attachments API
isOdataApi: false
relativePath: ''
discoveryPath: docs/bearer.v1
_isAuthorizedAccess: true
servers:
- url: https://sb2fixxbook.servicechannel.com:443/api
security:
- oauth2: []
tags:
- name: Attachments
paths:
/workorders/{workorderId}/notes/{noteId}/attachments:
post:
tags:
- Attachments
summary: Add Attachments to Work Order Note
description: <para>Add Attachments to Work Order Note. Returns list of attachments Id for successful request.</para>
operationId: POSTv3_workorders_{workorderId}_notes_{noteId}_attachments
parameters:
- name: workorderId
in: path
description: Numeric Id of the Work order to perform action with.
required: true
schema:
type: integer
format: int32
- name: noteId
in: path
description: Numeric Id of the Note to perform action with.
required: true
schema:
type: integer
format: int64
responses:
'201':
description: Created indicates that the request resulted in a new resource created before the response was sent.
'400':
description: "Bad Request - the request could not be understood or was missing required parameters.\n <br/>Error codes:\n <br/> 503 - Validation fails;\n <br/> 917 - InvalidWoIdentifier;"
content:
application/json:
schema:
$ref: '#/components/schemas/ServiceChannel.Services.Messaging.ErrorResponse'
text/json:
schema:
$ref: '#/components/schemas/ServiceChannel.Services.Messaging.ErrorResponse'
'401':
description: "Indicates that the requested resource requires authentication.\n <br/>Error codes:\n <br/> 504 - API call rejected by security permissions;"
content:
application/json:
schema:
$ref: '#/components/schemas/ServiceChannel.Services.Messaging.ErrorResponse'
text/json:
schema:
$ref: '#/components/schemas/ServiceChannel.Services.Messaging.ErrorResponse'
'500':
description: Indicates that a generic error has occurred on the server.
content:
application/json:
schema:
$ref: '#/components/schemas/ServiceChannel.Services.Messaging.ErrorResponse'
text/json:
schema:
$ref: '#/components/schemas/ServiceChannel.Services.Messaging.ErrorResponse'
deprecated: false
x-access: Any
requestBody:
content:
multipart/form-data:
schema:
type: object
properties:
AddAttachmentsRequest:
type: application/json
description: Optional Descriptor for file(s)
file:
type: string
description: File to attach to note
format: binary
required:
- file
/rfps/{id}/attachments:
post:
tags:
- Attachments
summary: Add attchment to RFP
description: <para>Adds attchment to RFP. Returns RFP attachment Id for successful request.</para>
operationId: POSTv3_rfps_{id}_attachments
parameters:
- name: id
in: path
description: Rfp ID to perform action with.
required: true
schema:
type: integer
format: int32
responses:
'201':
description: Created indicates that the request resulted in a new resource created before the response was sent.
'400':
description: "Bad Request - the request could not be understood or was missing required parameters.\n <br/>Error codes:\n <br/> 501 - Failed to upload attachment;\n <br/> 502 - Data not found. Returned if target Rfp is not found;\n <br/> 503 - Request data is empty;\n <br/>Invalid Attachment Request;\n <br/>User info should not be null;\n <br/>SubscriberId is null;\n <br/>Cannot accept file(s) of this type;\n <br/>The file that you're trying to attach has name that exceed the maximum allowable name length;\n <br/>The file that you're trying to attach has length that exceed the maximum allowable length;\n <br/>Empty Location or Store ID;\n <br/>Empty Provider ID;\n <br/>Provider is not valid;"
content:
application/json:
schema:
$ref: '#/components/schemas/ServiceChannel.Services.Messaging.ErrorResponse'
text/json:
schema:
$ref: '#/components/schemas/ServiceChannel.Services.Messaging.ErrorResponse'
'401':
description: "Indicates that the requested resource requires authentication.\n <br/>Error codes:\n <br/> 504 - API call rejected by security permissions;"
content:
application/json:
schema:
$ref: '#/components/schemas/ServiceChannel.Services.Messaging.ErrorResponse'
text/json:
schema:
$ref: '#/components/schemas/ServiceChannel.Services.Messaging.ErrorResponse'
'500':
description: Indicates that a generic error has occurred on the server.
content:
application/json:
schema:
$ref: '#/components/schemas/ServiceChannel.Services.Messaging.ErrorResponse'
text/json:
schema:
$ref: '#/components/schemas/ServiceChannel.Services.Messaging.ErrorResponse'
deprecated: false
x-access: Subscribers
requestBody:
content:
multipart/form-data:
schema:
type: object
properties:
file:
type: string
description: File to attach to RFP
format: binary
required:
- file
/siteaudit/comments/{commentId}/attachments:
get:
tags:
- Attachments
summary: Returns list of attachment ids and urls.
operationId: GETv3_siteaudit_comments_{commentId}_attachments
parameters:
- name: commentId
in: path
description: Numeric Id of the Comment which Attachment belongs to.
required: true
schema:
type: integer
format: int32
responses:
'200':
description: Request succeeded and the requested information is in the response.
content:
application/json:
schema:
type: array
items:
$ref: '#/components/schemas/ServiceChannel.Api.Model.SiteAudit.AttachmentInComment'
text/json:
schema:
type: array
items:
$ref: '#/components/schemas/ServiceChannel.Api.Model.SiteAudit.AttachmentInComment'
'400':
description: "Bad Request - the request could not be executed or was missing required parameters.\n <br/>Error codes:\n <br/> 503 - validation fails;"
content:
application/json:
schema:
$ref: '#/components/schemas/ServiceChannel.Services.Messaging.ErrorResponse'
text/json:
schema:
$ref: '#/components/schemas/ServiceChannel.Services.Messaging.ErrorResponse'
'401':
description: "Unauthorized indicates that the requested resource requires authentication.\n <br/>Error codes:\n <br/> 504 - API call rejected by security permissions;"
content:
application/json:
schema:
$ref: '#/components/schemas/ServiceChannel.Services.Messaging.ErrorResponse'
text/json:
schema:
$ref: '#/components/schemas/ServiceChannel.Services.Messaging.ErrorResponse'
'404':
description: "The requested resource does not exist on the server.\n <br/>Error codes:\n 502 — Data not found"
deprecated: false
x-access: Any
post:
tags:
- Attachments
summary: Add attchment to Comment
description: Adds attchment to Comment. If Comment is not created yet specify {commentId} = -1.
operationId: POSTv3_siteaudit_comments_{commentId}_attachments
parameters:
- name: commentId
in: path
description: Numeric Id of the Comment to perform action with.
required: true
schema:
type: integer
format: int32
responses:
'201':
description: Created indicates that the request resulted in a new resource created before the response was sent.
'400':
description: "Bad Request - the request could not be understood or was missing required parameters.\n <br/>Error codes:\n <br/> 501 - Failed to upload attachment;\n <br/> 502 - Data not found. Returned if target Comment is not found;\n <br/> 503 - Request data is empty;"
content:
application/json:
schema:
$ref: '#/components/schemas/ServiceChannel.Services.Messaging.ErrorResponse'
text/json:
schema:
$ref: '#/components/schemas/ServiceChannel.Services.Messaging.ErrorResponse'
'401':
description: "Indicates that the requested resource requires authentication.\n <br/>Error codes:\n <br/> 504 - API call rejected by security permissions;"
content:
application/json:
schema:
$ref: '#/components/schemas/ServiceChannel.Services.Messaging.ErrorResponse'
text/json:
schema:
$ref: '#/components/schemas/ServiceChannel.Services.Messaging.ErrorResponse'
'500':
description: Indicates that a generic error has occurred on the server.
content:
application/json:
schema:
$ref: '#/components/schemas/ServiceChannel.Services.Messaging.ErrorResponse'
text/json:
schema:
$ref: '#/components/schemas/ServiceChannel.Services.Messaging.ErrorResponse'
deprecated: false
x-access: Any
requestBody:
content:
multipart/form-data:
schema:
type: object
properties:
file:
type: string
description: File to attach to Comment
format: binary
required:
- file
/siteaudit/comments/{commentId}/attachments/{attachmentId}:
get:
tags:
- Attachments
summary: Retrieve original attchment from Comment
operationId: GETv3_siteaudit_comments_{commentId}_attachments_{attachmentId}
parameters:
- name: commentId
in: path
description: Numeric Id of the Comment which Attachment belongs to.
required: true
schema:
type: integer
format: int32
- name: attachmentId
in: path
description: Numeric Id of the Attachment to perform action with.
required: true
schema:
type: integer
format: int32
responses:
'200':
description: OK
content:
application/json:
schema:
$ref: '#/components/schemas/System.Object'
text/json:
schema:
$ref: '#/components/schemas/System.Object'
deprecated: false
x-access: Any
/siteaudit/comments/{commentId}/attachments/{attachmentId}/thumbnail:
get:
tags:
- Attachments
summary: Retrieve resized attchment from Comment
operationId: GETv3_siteaudit_comments_{commentId}_attachments_{attachmentId}_thumbnail?width={width}&height={height}&mode={mode}&imageFormat={imageFormat}
parameters:
- name: commentId
in: path
description: Numeric Id of the Comment which Attachment belongs to.
required: true
schema:
type: integer
format: int32
- name: attachmentId
in: path
description: Numeric Id of the Attachment to perform action with.
required: true
schema:
type: integer
format: int32
- name: width
in: query
description: Width of the output file.
required: false
schema:
type: integer
format: int32
- name: height
in: query
description: Height of the output file.
required: false
schema:
type: integer
format: int32
- name: mode
in: query
description: "How to resolve aspect ratio differences between the requested size and the \n original image's size: Max = 1, Pad = 2, Crop = 3, Carve = 4, Stretch = 5."
required: false
schema:
type: string
enum:
- None
- Max
- Pad
- Crop
- Carve
- Stretch
- name: imageFormat
in: query
description: "The desired image format, like 'jpg', 'gif', or 'png'. Do not specify \n if you want to preserve the original format."
required: false
schema:
type: string
responses:
'200':
description: OK
content:
application/json:
schema:
$ref: '#/components/schemas/System.Object'
text/json:
schema:
$ref: '#/components/schemas/System.Object'
deprecated: false
x-access: Any
/assets/{assetId}/attachments:
get:
tags:
- Attachments
summary: Get Asset Attachments
description: ''
operationId: GETv3_assets_{assetId}_attachments?providerId={providerId}
parameters:
- name: assetId
in: path
description: Asset Identifier
required: true
schema:
type: integer
format: int32
- name: providerId
in: query
description: The provider identifier. Required for sub-contractor request. [Required Special permissions]
required: false
schema:
type: integer
format: int32
responses:
'200':
description: Request succeeded and the requested information is in the response.
content:
application/json:
schema:
type: array
items:
$ref: '#/components/schemas/ServiceChannel.Services.Messaging.Assets.AssetAttachment'
text/json:
schema:
type: array
items:
$ref: '#/components/schemas/ServiceChannel.Services.Messaging.Assets.AssetAttachment'
'400':
description: "Bad Request - the request could not be executed or was missing required parameters.\n <br/>Error codes:\n <br/> 503 - User info should not be null;\n <br/>SubscriberId is null;"
content:
application/json:
schema:
$ref: '#/components/schemas/ServiceChannel.Services.Messaging.ErrorResponse'
text/json:
schema:
$ref: '#/components/schemas/ServiceChannel.Services.Messaging.ErrorResponse'
'401':
description: "Unauthorized indicates that the requested resource requires authentication.\n <br/>Error codes:\n <br/> 504 - API call rejected by security permissions;"
content:
application/json:
schema:
$ref: '#/components/schemas/ServiceChannel.Services.Messaging.ErrorResponse'
text/json:
schema:
$ref: '#/components/schemas/ServiceChannel.Services.Messaging.ErrorResponse'
deprecated: false
x-access: Any
post:
tags:
- Attachments
summary: Add Attachments to Asset
operationId: POSTv3_assets_{assetId}_attachments?isDefault={isDefault}
parameters:
- name: assetId
in: path
required: true
schema:
type: integer
format: int32
- name: isDefault
in: query
required: false
schema:
type: boolean
default: false
responses:
'200':
description: Created indicates that the request resulted in a new resource created before the response was sent.
content:
application/json:
schema:
type: array
items:
$ref: '#/components/schemas/ServiceChannel.Services.Messaging.Assets.AddAssetAttachmentResponse'
text/json:
schema:
type: array
items:
$ref: '#/components/schemas/ServiceChannel.Services.Messaging.Assets.AddAssetAttachmentResponse'
'400':
description: "Bad Request - the request could not be executed or was missing required parameters.\n <br/>Error codes:\n <br/> 502 - Asset Not found;\n < br/> 503 - Bad Request;"
content:
application/json:
schema:
$ref: '#/components/schemas/ServiceChannel.Services.Messaging.ErrorResponse'
text/json:
schema:
$ref: '#/components/schemas/ServiceChannel.Services.Messaging.ErrorResponse'
'401':
description: "Indicates that the requested resource requires authentication.\n <br/>Error codes:\n <br/> 504 - API call rejected by security permissions;"
content:
application/json:
schema:
$ref: '#/components/schemas/ServiceChannel.Services.Messaging.ErrorResponse'
text/json:
schema:
$ref: '#/components/schemas/ServiceChannel.Services.Messaging.ErrorResponse'
'500':
description: Indicates that a generic error has occurred on the server.
content:
application/json:
schema:
$ref: '#/components/schemas/ServiceChannel.Services.Messaging.ErrorResponse'
text/json:
schema:
$ref: '#/components/schemas/ServiceChannel.Services.Messaging.ErrorResponse'
deprecated: false
x-access: Any
requestBody:
content:
multipart/form-data:
schema:
type: object
properties:
AddAttachmentsRequest:
type: application/json
description: Required Descriptor for file(s)
file:
type: string
description: File to attach to workorder
format: binary
required:
- file
/assets/{assetAttachmentId}/deleteAttachment:
post:
tags:
- Attachments
summary: Delete Asset Attachment
operationId: POSTv3_assets_{assetAttachmentId}_deleteAttachment
parameters:
- name: assetAttachmentId
in: path
required: true
schema:
type: integer
format: int32
responses:
'200':
description: Request succeeded and the requested information is in the response.
content:
application/json:
schema:
$ref: '#/components/schemas/System.Object'
text/json:
schema:
$ref: '#/components/schemas/System.Object'
'400':
description: "Bad Request - the request could not be executed or was missing required parameters.\n <br/>Error codes:\n <br/> 503 - User info should not be null;\n <br/>SubscriberId is null;"
content:
application/json:
schema:
$ref: '#/components/schemas/ServiceChannel.Services.Messaging.ErrorResponse'
text/json:
schema:
$ref: '#/components/schemas/ServiceChannel.Services.Messaging.ErrorResponse'
'401':
description: "Unauthorized indicates that the requested resource requires authentication.\n <br/>Error codes:\n <br/> 504 - API call rejected by security permissions;"
content:
application/json:
schema:
$ref: '#/components/schemas/ServiceChannel.Services.Messaging.ErrorResponse'
text/json:
schema:
$ref: '#/components/schemas/ServiceChannel.Services.Messaging.ErrorResponse'
deprecated: false
x-access: Any
/assets/getattachmentsbyassetids:
post:
tags:
- Attachments
summary: Get Asset Attachments
operationId: POSTv3_assets_getattachmentsbyassetids
responses:
'200':
description: Request succeeded and the requested information is in the response.
content:
application/json:
schema:
type: object
additionalProperties:
type: array
items:
$ref: '#/components/schemas/ServiceChannel.Services.Messaging.Assets.AssetAttachment'
text/json:
schema:
type: object
additionalProperties:
type: array
items:
$ref: '#/components/schemas/ServiceChannel.Services.Messaging.Assets.AssetAttachment'
'400':
description: "Bad Request - the request could not be executed or was missing required parameters.\n <br/>Error codes:\n <br/> 503 - User info should not be null;\n <br/>SubscriberId is null;"
content:
application/json:
schema:
$ref: '#/components/schemas/ServiceChannel.Services.Messaging.ErrorResponse'
text/json:
schema:
$ref: '#/components/schemas/ServiceChannel.Services.Messaging.ErrorResponse'
'401':
description: "Unauthorized indicates that the requested resource requires authentication.\n <br/>Error codes:\n <br/> 504 - API call rejected by security permissions;"
content:
application/json:
schema:
$ref: '#/components/schemas/ServiceChannel.Services.Messaging.ErrorResponse'
text/json:
schema:
$ref: '#/components/schemas/ServiceChannel.Services.Messaging.ErrorResponse'
deprecated: false
x-access: Any
requestBody:
content:
application/json:
schema:
type: array
items:
format: int32
type: integer
text/json:
schema:
type: array
items:
format: int32
type: integer
required: true
/assets/getattachmentsbyassetids_v1:
post:
tags:
- Attachments
summary: Get Asset Attachments
operationId: POSTv3_assets_getattachmentsbyassetids_v1
responses:
'200':
description: Request succeeded and the requested information is in the response.
content:
application/json:
schema:
type: object
additionalProperties:
type: array
items:
$ref: '#/components/schemas/ServiceChannel.Services.Messaging.Assets.AssetAttachment'
text/json:
schema:
type: object
additionalProperties:
type: array
items:
$ref: '#/components/schemas/ServiceChannel.Services.Messaging.Assets.AssetAttachment'
'400':
description: "Bad Request - the request could not be executed or was missing required parameters.\n <br/>Error codes:\n <br/> 503 - User info should not be null;\n <br/>SubscriberId is null;"
content:
application/json:
schema:
$ref: '#/components/schemas/ServiceChannel.Services.Messaging.ErrorResponse'
text/json:
schema:
$ref: '#/components/schemas/ServiceChannel.Services.Messaging.ErrorResponse'
'401':
description: "Unauthorized indicates that the requested resource requires authentication.\n <br/>Error codes:\n <br/> 504 - API call rejected by security permissions;"
content:
application/json:
schema:
$ref: '#/components/schemas/ServiceChannel.Services.Messaging.ErrorResponse'
text/json:
schema:
$ref: '#/components/schemas/ServiceChannel.Services.Messaging.ErrorResponse'
deprecated: false
x-access: Any
requestBody:
content:
application/json:
schema:
$ref: '#/components/schemas/ServiceChannel.Services.WebApi.Models.AssetAttachmentsRequest'
text/json:
schema:
$ref: '#/components/schemas/ServiceChannel.Services.WebApi.Models.AssetAttachmentsRequest'
required: true
/assets/updateAssetAttachment:
put:
tags:
- Attachments
summary: Update asset attachment by id
description: ''
operationId: PUTv3_assets_updateAssetAttachment?attachmentId={attachmentId}&fileName={fileName}&description={description}
parameters:
- name: attachmentId
in: query
description: Attachment identifier
required: true
schema:
type: integer
format: int32
- name: fileName
in: query
description: New file name
required: false
schema:
type: string
- name: description
in: query
description: New file description(comment)
required: false
schema:
type: string
responses:
'200':
description: Request succeeded and the requested information is in the response.
content:
application/json:
schema:
$ref: '#/components/schemas/System.Object'
text/json:
schema:
$ref: '#/components/schemas/System.Object'
'400':
description: "Bad Request - the request could not be understood or was missing required parameters.\n <br/>Error codes:\n <br/> 503 - FileName or Description is required;"
content:
application/json:
schema:
$ref: '#/components/schemas/ServiceChannel.Services.Messaging.ErrorResponse'
text/json:
schema:
$ref: '#/components/schemas/ServiceChannel.Services.Messaging.ErrorResponse'
'401':
description: "Unauthorized indicates that the requested resource requires authentication.\n <br/>Error codes:\n <br/> 504 - API call rejected by security permissions;"
content:
application/json:
schema:
$ref: '#/components/schemas/ServiceChannel.Services.Messaging.ErrorResponse'
text/json:
schema:
$ref: '#/components/schemas/ServiceChannel.Services.Messaging.ErrorResponse'
deprecated: false
x-access: Any
/workrequest/{workRequestId}/attachments:
get:
tags:
- Attachments
summary: Get WorkRequest Attachments
description: '*In limited availability phase.*'
operationId: GETv3_workrequest_{workRequestId}_attachments
parameters:
- name: workRequestId
in: path
description: WorkRequest Identifier
required: true
schema:
type: integer
format: int32
responses:
'200':
description: Request succeeded and the requested information is in the response.
content:
application/json:
schema:
type: array
items:
$ref: '#/components/schemas/ServiceChannel.Services.Messaging.Attachments.Attachment'
text/json:
schema:
type: array
items:
$ref: '#/components/schemas/ServiceChannel.Services.Messaging.Attachments.Attachment'
'401':
description: "Unauthorized indicates that the requested resource requires authentication.\n <br/>Error codes:\n <br/> 504 - API call rejected by security permissions;"
content:
application/json:
schema:
$ref: '#/components/schemas/ServiceChannel.Services.Messaging.ErrorResponse'
text/json:
schema:
$ref: '#/components/schemas/ServiceChannel.Services.Messaging.ErrorResponse'
deprecated: false
x-access: Any
post:
tags:
- Attachments
summary: Add attachments to a WorkRequest
description: "*In limited availability phase.*\n <br />Adds attachments to the specified WorkRequest."
operationId: POSTv3_workrequest_{workRequestId}_attachments?actor={actor}
parameters:
- name: workRequestId
in: path
description: Numeric ID of the WorkRequest to add attachments to.
required: true
schema:
type: integer
format: int32
- name: actor
in: query
description: Name of the person on whose behalf you are performing the action
required: false
schema:
type: string
responses:
'201':
description: Created indicates that the request resulted in a new resource created before the response was sent.
'400':
description: "Bad Request - the request could not be understood or was missing required parameters.\n <br/>Error codes:\n <br/> 502 - Work Request not found;"
content:
application/json:
schema:
$ref: '#/components/schemas/ServiceChannel.Services.Messaging.ErrorResponse'
text/json:
schema:
$ref: '#/components/schemas/ServiceChannel.Services.Messaging.ErrorResponse'
'401':
description: "Indicates that the requested resource requires authentication.\n <br/>Error codes:\n <br/> 504 - API call rejected by security permissions;"
content:
application/json:
schema:
$ref: '#/components/schemas/ServiceChannel.Services.Messaging.ErrorResponse'
text/json:
schema:
$ref: '#/components/schemas/ServiceChannel.Services.Messaging.ErrorResponse'
'500':
description: Indicates that a generic error has occurred on the server.
content:
application/json:
schema:
$ref: '#/components/schemas/ServiceChannel.Services.Messaging.ErrorResponse'
text/json:
schema:
$ref: '#/components/schemas/ServiceChannel.Services.Messaging.ErrorResponse'
deprecated: false
x-access: Any
requestBody:
content:
multipart/form-data:
schema:
type: object
properties:
AddAttachmentsRequest:
type: application/json
file:
type: string
description: File to attach to the work request.
format: binary
required:
- file
/workrequest/{workRequestId}/notes/{noteId}/attachments:
post:
tags:
- Attachments
summary: Add Attachments to Work Request Note
description: "*In limited availability phase.*\n <br />Add Attachments to Work Request Note. Returns list of attachments Id for successful request."
operationId: POSTv3_workrequest_{workRequestId}_no
# --- truncated at 32 KB (150 KB total) ---
# Full source: https://raw.githubusercontent.com/api-evangelist/servicechannel/refs/heads/main/openapi/servicechannel-attachments-api-openapi.yml