FieldEdge Open API
dev
  • production
  • dev
DocsAPIs
DocsAPIs
dev
  • production
  • dev
dev
  • production
  • dev
  1. CustomerAttachments
  • Lead
    • Creates a new lead with customer details, appointment preferences, and service information.
      POST
    • Fetches lead details based on the provided lead identifier.
      GET
  • Customer
    • Creates a new customer
      POST
    • Updates an existing customer
      PUT
    • Retrieve customer by phone number
      GET
    • Search customers with optional filters
      GET
    • Retrieve customers based on address details.
      GET
    • Retrieve customer details by ID
      GET
  • CustomerAttachments
    • Upload a file attachment to a customer record
      POST
    • Retrieve attachments for a customer
      GET
  • CustomerNotes
    • Create a note on a customer record
      POST
    • Retrieve all notes for a customer
      GET
    • Update an existing customer note
      PATCH
  • CustomerTags
    • Associate a tag with a customer
      POST
    • Remove a tag from a customer
      DELETE
    • Create a reusable customer tag
      POST
    • Retrieve tags
      GET
  • Item
    • Creates a new inventory item
      POST
    • Retrieve a paginated list of inventory items with optional filters
      GET
    • Bulk update inventory items
      PATCH
    • Updates an existing inventory item
      PATCH
    • Retrieve an inventory item by ID
      GET
    • Retrieve availability of an item across one or more warehouses
      GET
  • ItemCategory
    • Retrieve list of item categories
    • Create a new item category
    • Retrieve item category by id.
    • Partially update an item category
  • SalesTaxCode
    • Retrieve list of sales tax codes
  • WorkOrder
    • Retrieve a paginated list of work orders
    • Retrieve a work order by ID
    • Retrieve work orders at a given address, most recent first
    • Create a new work order
    • Update an existing work order
    • Retrieve list of business units
    • Retrieve business unit by id.
    • Retrieve list of lead sources
    • Retrieve lead source by id.
  • Assignments
    • Retrieve all technician assignments for a work order
    • Assign a technician to a work order
  • Agreement
    • Retrieve list of agreements
    • Retrieve agreement by id.
  • Invoice
    • Retrieve a paginated list of invoices
    • Retrieve an invoice by ID
  • Quote
    • Retrieve a paginated list of quotes
    • Retrieve a quote by ID
  • Task
    • Retrieve a task bundle by ID
    • Retrieve a list of tasks
  • Warehouse
    • Create a new warehouse
    • Retrieve a paginated list of warehouses
    • Update an existing warehouse
    • Retrieve a warehouse by ID
  • Employee
    • Retrieve a paginated list of employees
    • Retrieve an employee by ID
  • Company
    • Retrieve company name by ID
  • Webhook
    • Register a webhook endpoint to receive event notifications.
    • Delete the registered webhook for the authenticated account.
    • Rotate the HMAC signing secret for the registered webhook.
  1. CustomerAttachments

Retrieve attachments for a customer

GET
/v1/customers/{customerId}/attachments
Returns a paginated list of file attachments associated with the specified customer record. Each item includes the blob URL required to download or view the file. Supports offset and limit for pagination and a sort parameter to control ordering. Default sort is createdAt descending (newest first).
Required scope: customers:read

Request

Authorization
or
Path Params

Query Params

Responses

🟢200
application/json
Attachments retrieved successfully.
Bodyapplication/json

🟢204
🟠400
🟠401
🟠403
🟠404
🔴500
Request Request Example
Shell
JavaScript
Java
Swift
curl --location 'https://dev.api.fieldedge.com/open-api/v1/customers//attachments?offset=&limit=&sort='
Response Response Example
200 - Sample paginated list of attachments for a customer
{
    "total": 2,
    "offset": 0,
    "limit": 20,
    "data": [
        {
            "attachmentId": "a3f1b2c4-5d6e-7f8a-9b0c-1d2e3f4a5b6c",
            "customerId": "9f1a6b1c-3a3e-4b91-9a2f-2c6a9fbb1234",
            "fileName": "inspection-report.pdf",
            "fileType": "document",
            "fileUrl": "https://storageaccount.blob.core.windows.net/company/inspection-report_3f2504e04f8941d39a0c0305e82c3301.pdf",
            "fileSizeBytes": 542118,
            "description": "Annual inspection report",
            "createdAt": "2026-02-09T10:15:30Z"
        },
        {
            "attachmentId": "b4e2c3d5-6e7f-8a9b-0c1d-2e3f4a5b6c7d",
            "customerId": "9f1a6b1c-3a3e-4b91-9a2f-2c6a9fbb1234",
            "fileName": "site-photo.jpg",
            "fileType": "image",
            "fileUrl": "https://storageaccount.blob.core.windows.net/company/site-photo_5b6c7d8e9f0a1b2c3d4e5f6a7b8c9d0e.jpg",
            "fileSizeBytes": 102400,
            "description": null,
            "createdAt": "2026-01-15T08:00:00Z"
        }
    ]
}
Modified at 2026-08-27 11:27:54
Previous
Upload a file attachment to a customer record
Next
Create a note on a customer record
Built with