Sign in
Attachment

Find attachments based on search parameters.

post/api/attachments/list

Query parameters

Sort.Fieldstring

Sort field

Sort.Dir'ascending' | 'descending'

Specify sorting direction.

Sort direction

Skipinteger

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.

Takeinteger

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.

Request body

attachmentIdsstring[] nullable

Filter to attachments whose ids are in the list.

formatsCommonEnumAttachmentMediaFormatEnum[] nullable

Allows for filtering based on specific attachment format types.

Response

List of attachments matching the filters

idstring required

Unique Id associated to this entity

namestring nullable

The file name.

descriptionstring nullable

Description

type'standard' | 'externalAccessDocument' | 'certification'

Attachment types

format'undefined' | 'cad' | 'document' | 'image' | 'video'

Attachment format

sizeinteger nullable

File size in bytes

fileIdstring required

Internal file identifier

createdUtcstring date-time

UTC timestamp when this attachment record was created on its current owner. Note: when an attachment is copied between owners (for example, from a quote to a job), a new attachment record is created and this value reflects the copy time, not the original upload time.

Changes