Esc

↑↓ move↵ openIndex · Pagefind
REST reference · Project Management

Transmittals

11 endpoints11 implementedAll modules →
  1. GET /rest/v1.0/transmittalsList visible project transmittals
  2. POST /rest/v1.0/transmittalsCreate a transmittal
  3. GET /rest/v1.0/transmittals/{id}Get a visible transmittal
  4. PATCH /rest/v1.0/transmittals/{id}Update a transmittal
  5. DELETE /rest/v1.0/transmittals/{id}Move a transmittal to the recycle bin
  6. GET /rest/v1.0/transmittals/{id}/items/{item_id}/downloadDownload transmittal item
  7. PATCH /rest/v1.0/transmittals/{id}/receiptsUpdate a current recipient receipt
  8. POST /rest/v1.0/transmittals/{id}/restoreRestore a recycled transmittal
  9. PATCH /rest/v1.0/transmittals/{id}/restoreRestore a recycled transmittal
  10. POST /rest/v1.0/transmittals/create_fromCreate a transmittal from documents or drawings
  11. GET /rest/v1.0/transmittals/recycle_binList recycled project transmittals
GET /rest/v1.0/transmittals

List visible project transmittals

Authorization and record visibility are checked by the existing REST handler; catalog presence does not grant access.

v1.0Implemented

Parameters

  • project_id
    integerqueryrequired
  • page
    integerquery
  • per_page
    integerquery
  • search
    stringquery
  • sort
    stringquery
    One of: number, -number, date, -date, created_at, -created_at.
  • filters[id]
    stringquery
    Comma-separated filter values
  • filters[sent_via]
    stringquery
    Comma-separated filter values
  • filters[submitted_for]
    stringquery
    Comma-separated filter values
  • filters[from_id]
    stringquery
    Comma-separated filter values
  • filters[search]
    stringquery
    Comma-separated filter values

Response · 200 · object[]

  • id
    integerrequired
  • number
    stringrequired
  • subject
    string | nullrequired
  • date
    string | nullrequired
  • to
    object[]required
  • to[].id
    integerrequired
  • to[].login
    stringrequired
  • to[].name
    stringrequired
  • cc
    object[]required
  • cc[].id
    integerrequired
  • cc[].login
    stringrequired
  • cc[].name
    stringrequired
  • from
    null | objectrequired
  • from.id
    integerrequired
  • from.login
    stringrequired
  • from.name
    stringrequired
  • sent_via
    anyrequired
    One of: attached, under_separate_cover, null.
  • private
    booleanrequired
  • submitted_for
    anyrequired
    One of: approval, your_use, as_requested, review_and_comment, further_processing, null.
  • actions
    object[]required
  • actions[].action
    stringrequired
    One of: out_for_signature, approved_as_submitted, approved_as_noted, submit, resubmitted, returned, returned_for_corrections, resubmit, due_by, received, received_as_noted, sent_date.
  • actions[].date
    string | nullrequired
  • remarks
    string | nullrequired
  • status
    anyrequired
    One of: sent, delivered.
  • delivered_date
    string | nullrequired
  • email_recorded_at
    string | nullrequired
  • items
    object[]required
  • items[].id
    integerrequired
  • items[].format
    stringrequired
    One of: Attic Stock, CDs, Commitment Contract, Communication, Document, Other, Plans, Potential Change Order, Prime Contract, Prints, Punch List Item, Purchase Order Contract, RFI, Samples, Shop Drawings, Submittal Log, Submittal Package.
  • items[].description
    stringrequired
  • items[].date
    string | nullrequired
  • items[].quantity
    integer | nullrequired
  • items[].notes
    string | nullrequired
  • items[].item_type
    stringrequired
    One of: freeform, document, drawing.
  • items[].ref_id
    integer | nullrequired
  • items[].ref
    null | objectrequired
  • items[].document_version_id
    integer | nullrequired
  • items[].drawing_revision_id
    integer | nullrequired
  • items[].source_upload_id
    integer | nullrequired
  • items[].source_revision_label
    string | nullrequired
  • created_by
    null | objectrequired
  • created_by.id
    integerrequired
  • created_by.login
    stringrequired
  • created_by.name
    stringrequired
  • created_at
    stringrequired
  • updated_at
    stringrequired
  • receipts
    object[]required
  • receipts[].user
    null | objectrequired
  • receipts[].received
    booleanrequired
  • receipts[].received_at
    string | nullrequired
  • receipts[].acknowledged
    booleanrequired

Errors

  • 401Authentication required
  • 403Permission denied
  • 404Record unavailable in the authorized project
  • 422Invalid request or business validation failure

Example request

Generated from the contractcurl
curl -X GET "https://app.os.construction/rest/v1.0/transmittals" \
  -H "Authorization: Bearer $OS_ACCESS_TOKEN"
POST /rest/v1.0/transmittals

Create a transmittal

Creates a transmittal. deliver=true queues recipient email notifications and requires a UUID submission_key plus at least one recipient. Referenced documents/drawings require their corresponding source permissions. Authorization and record visibility are checked by the existing REST handler; catalog presence does not grant access.

v1.0Implemented

Parameters

  • project_id
    integerqueryrequired
  • Idempotency-Key
    stringheader
    Optional. A unique key (1-255 visible ASCII characters, e.g. a UUID) that makes a retry safe. The first request with a key runs; a 2xx response is stored for 24 hours and a retry with the same key, token and path gets that response again with `Idempotent-Replayed: true`. The same key with a different request returns 422; while the first request is still running, 409. A non-2xx response releases the key.

Request body

  • transmittal
    objectrequired
  • transmittal.number
    string
  • transmittal.subject
    stringrequired
  • transmittal.date
    string | null
  • transmittal.to_ids
    integer[]
  • transmittal.cc_ids
    integer[]
  • transmittal.sent_via
    string | null
    One of: attached, under_separate_cover.
  • transmittal.private
    boolean
  • transmittal.submitted_for
    string | null
    One of: approval, your_use, as_requested, review_and_comment, further_processing.
  • transmittal.actions
    string[]
    One of: out_for_signature, approved_as_submitted, approved_as_noted, submit, resubmitted, returned, returned_for_corrections, resubmit, due_by, received, received_as_noted, sent_date.
  • transmittal.due_by_date
    string | null
  • transmittal.sent_date
    string | null
  • transmittal.remarks
    string | null
  • transmittal.items
    object[]
  • transmittal.items[].id
    integer
  • transmittal.items[].document_version_id
    integer
  • transmittal.items[].drawing_revision_id
    integer
  • transmittal.items[].source_upload_id
    any
  • transmittal.items[].sourceUploadId
    any
  • transmittal.items[].source_revision_label
    any
  • transmittal.items[].sourceRevisionLabel
    any
  • transmittal.items[].format
    stringrequired
    One of: Attic Stock, CDs, Commitment Contract, Communication, Document, Other, Plans, Potential Change Order, Prime Contract, Prints, Punch List Item, Purchase Order Contract, RFI, Samples, Shop Drawings, Submittal Log, Submittal Package.
  • transmittal.items[].description
    string
  • transmittal.items[].date
    string | null
  • transmittal.items[].quantity
    integer | null
  • transmittal.items[].notes
    string | null
  • transmittal.items[].item_type
    string
    One of: freeform, document, drawing.
  • transmittal.items[].ref_id
    integer | null
  • transmittal.deliver
    boolean
  • transmittal.submission_key
    string (uuid)

Response · 201 · object

  • id
    integerrequired
  • number
    stringrequired
  • subject
    string | nullrequired
  • date
    string | nullrequired
  • to
    object[]required
  • to[].id
    integerrequired
  • to[].login
    stringrequired
  • to[].name
    stringrequired
  • cc
    object[]required
  • cc[].id
    integerrequired
  • cc[].login
    stringrequired
  • cc[].name
    stringrequired
  • from
    null | objectrequired
  • from.id
    integerrequired
  • from.login
    stringrequired
  • from.name
    stringrequired
  • sent_via
    anyrequired
    One of: attached, under_separate_cover, null.
  • private
    booleanrequired
  • submitted_for
    anyrequired
    One of: approval, your_use, as_requested, review_and_comment, further_processing, null.
  • actions
    object[]required
  • actions[].action
    stringrequired
    One of: out_for_signature, approved_as_submitted, approved_as_noted, submit, resubmitted, returned, returned_for_corrections, resubmit, due_by, received, received_as_noted, sent_date.
  • actions[].date
    string | nullrequired
  • remarks
    string | nullrequired
  • status
    anyrequired
    One of: sent, delivered.
  • delivered_date
    string | nullrequired
  • email_recorded_at
    string | nullrequired
  • items
    object[]required
  • items[].id
    integerrequired
  • items[].format
    stringrequired
    One of: Attic Stock, CDs, Commitment Contract, Communication, Document, Other, Plans, Potential Change Order, Prime Contract, Prints, Punch List Item, Purchase Order Contract, RFI, Samples, Shop Drawings, Submittal Log, Submittal Package.
  • items[].description
    stringrequired
  • items[].date
    string | nullrequired
  • items[].quantity
    integer | nullrequired
  • items[].notes
    string | nullrequired
  • items[].item_type
    stringrequired
    One of: freeform, document, drawing.
  • items[].ref_id
    integer | nullrequired
  • items[].ref
    null | objectrequired
  • items[].document_version_id
    integer | nullrequired
  • items[].drawing_revision_id
    integer | nullrequired
  • items[].source_upload_id
    integer | nullrequired
  • items[].source_revision_label
    string | nullrequired
  • created_by
    null | objectrequired
  • created_by.id
    integerrequired
  • created_by.login
    stringrequired
  • created_by.name
    stringrequired
  • created_at
    stringrequired
  • updated_at
    stringrequired
  • receipts
    object[]required
  • receipts[].user
    null | objectrequired
  • receipts[].received
    booleanrequired
  • receipts[].received_at
    string | nullrequired
  • receipts[].acknowledged
    booleanrequired

Errors

  • 401Authentication required
  • 403Permission denied
  • 404Record unavailable in the authorized project
  • 422Invalid request or business validation failure

Example request

Generated from the contractcurl
curl -X POST "https://app.os.construction/rest/v1.0/transmittals" \
  -H "Authorization: Bearer $OS_ACCESS_TOKEN" \
  -H "Idempotency-Key: $(uuidgen)" \
  -H 'Content-Type: application/json' \
  -d '{
  "transmittal": {
    "subject": "string"
  }
}'
GET /rest/v1.0/transmittals/{id}

Get a visible transmittal

Authorization and record visibility are checked by the existing REST handler; catalog presence does not grant access.

v1.0Implemented

Parameters

  • id
    integerpathrequired
  • project_id
    integerquery

Response · 200 · object

  • id
    integerrequired
  • number
    stringrequired
  • subject
    string | nullrequired
  • date
    string | nullrequired
  • to
    object[]required
  • to[].id
    integerrequired
  • to[].login
    stringrequired
  • to[].name
    stringrequired
  • cc
    object[]required
  • cc[].id
    integerrequired
  • cc[].login
    stringrequired
  • cc[].name
    stringrequired
  • from
    null | objectrequired
  • from.id
    integerrequired
  • from.login
    stringrequired
  • from.name
    stringrequired
  • sent_via
    anyrequired
    One of: attached, under_separate_cover, null.
  • private
    booleanrequired
  • submitted_for
    anyrequired
    One of: approval, your_use, as_requested, review_and_comment, further_processing, null.
  • actions
    object[]required
  • actions[].action
    stringrequired
    One of: out_for_signature, approved_as_submitted, approved_as_noted, submit, resubmitted, returned, returned_for_corrections, resubmit, due_by, received, received_as_noted, sent_date.
  • actions[].date
    string | nullrequired
  • remarks
    string | nullrequired
  • status
    anyrequired
    One of: sent, delivered.
  • delivered_date
    string | nullrequired
  • email_recorded_at
    string | nullrequired
  • items
    object[]required
  • items[].id
    integerrequired
  • items[].format
    stringrequired
    One of: Attic Stock, CDs, Commitment Contract, Communication, Document, Other, Plans, Potential Change Order, Prime Contract, Prints, Punch List Item, Purchase Order Contract, RFI, Samples, Shop Drawings, Submittal Log, Submittal Package.
  • items[].description
    stringrequired
  • items[].date
    string | nullrequired
  • items[].quantity
    integer | nullrequired
  • items[].notes
    string | nullrequired
  • items[].item_type
    stringrequired
    One of: freeform, document, drawing.
  • items[].ref_id
    integer | nullrequired
  • items[].ref
    null | objectrequired
  • items[].document_version_id
    integer | nullrequired
  • items[].drawing_revision_id
    integer | nullrequired
  • items[].source_upload_id
    integer | nullrequired
  • items[].source_revision_label
    string | nullrequired
  • created_by
    null | objectrequired
  • created_by.id
    integerrequired
  • created_by.login
    stringrequired
  • created_by.name
    stringrequired
  • created_at
    stringrequired
  • updated_at
    stringrequired
  • receipts
    object[]required
  • receipts[].user
    null | objectrequired
  • receipts[].received
    booleanrequired
  • receipts[].received_at
    string | nullrequired
  • receipts[].acknowledged
    booleanrequired

Errors

  • 401Authentication required
  • 403Permission denied
  • 404Record unavailable in the authorized project
  • 422Invalid request or business validation failure

Example request

Generated from the contractcurl
curl -X GET "https://app.os.construction/rest/v1.0/transmittals/1" \
  -H "Authorization: Bearer $OS_ACCESS_TOKEN"
PATCH /rest/v1.0/transmittals/{id}

Update a transmittal

Authorization and record visibility are checked by the existing REST handler; catalog presence does not grant access.

v1.0Implemented

Parameters

  • id
    integerpathrequired
  • project_id
    integerquery
  • Idempotency-Key
    stringheader
    Optional. A unique key (1-255 visible ASCII characters, e.g. a UUID) that makes a retry safe. The first request with a key runs; a 2xx response is stored for 24 hours and a retry with the same key, token and path gets that response again with `Idempotent-Replayed: true`. The same key with a different request returns 422; while the first request is still running, 409. A non-2xx response releases the key.

Request body

  • transmittal
    objectrequired
  • transmittal.number
    string
  • transmittal.subject
    string
  • transmittal.date
    string | null
  • transmittal.to_ids
    integer[]
  • transmittal.cc_ids
    integer[]
  • transmittal.sent_via
    string | null
    One of: attached, under_separate_cover.
  • transmittal.private
    boolean
  • transmittal.submitted_for
    string | null
    One of: approval, your_use, as_requested, review_and_comment, further_processing.
  • transmittal.actions
    string[]
    One of: out_for_signature, approved_as_submitted, approved_as_noted, submit, resubmitted, returned, returned_for_corrections, resubmit, due_by, received, received_as_noted, sent_date.
  • transmittal.due_by_date
    string | null
  • transmittal.sent_date
    string | null
  • transmittal.remarks
    string | null
  • transmittal.items
    object[]
  • transmittal.items[].id
    integer
  • transmittal.items[].document_version_id
    integer
  • transmittal.items[].drawing_revision_id
    integer
  • transmittal.items[].source_upload_id
    any
  • transmittal.items[].sourceUploadId
    any
  • transmittal.items[].source_revision_label
    any
  • transmittal.items[].sourceRevisionLabel
    any
  • transmittal.items[].format
    stringrequired
    One of: Attic Stock, CDs, Commitment Contract, Communication, Document, Other, Plans, Potential Change Order, Prime Contract, Prints, Punch List Item, Purchase Order Contract, RFI, Samples, Shop Drawings, Submittal Log, Submittal Package.
  • transmittal.items[].description
    string
  • transmittal.items[].date
    string | null
  • transmittal.items[].quantity
    integer | null
  • transmittal.items[].notes
    string | null
  • transmittal.items[].item_type
    string
    One of: freeform, document, drawing.
  • transmittal.items[].ref_id
    integer | null

Response · 200 · object

  • id
    integerrequired
  • number
    stringrequired
  • subject
    string | nullrequired
  • date
    string | nullrequired
  • to
    object[]required
  • to[].id
    integerrequired
  • to[].login
    stringrequired
  • to[].name
    stringrequired
  • cc
    object[]required
  • cc[].id
    integerrequired
  • cc[].login
    stringrequired
  • cc[].name
    stringrequired
  • from
    null | objectrequired
  • from.id
    integerrequired
  • from.login
    stringrequired
  • from.name
    stringrequired
  • sent_via
    anyrequired
    One of: attached, under_separate_cover, null.
  • private
    booleanrequired
  • submitted_for
    anyrequired
    One of: approval, your_use, as_requested, review_and_comment, further_processing, null.
  • actions
    object[]required
  • actions[].action
    stringrequired
    One of: out_for_signature, approved_as_submitted, approved_as_noted, submit, resubmitted, returned, returned_for_corrections, resubmit, due_by, received, received_as_noted, sent_date.
  • actions[].date
    string | nullrequired
  • remarks
    string | nullrequired
  • status
    anyrequired
    One of: sent, delivered.
  • delivered_date
    string | nullrequired
  • email_recorded_at
    string | nullrequired
  • items
    object[]required
  • items[].id
    integerrequired
  • items[].format
    stringrequired
    One of: Attic Stock, CDs, Commitment Contract, Communication, Document, Other, Plans, Potential Change Order, Prime Contract, Prints, Punch List Item, Purchase Order Contract, RFI, Samples, Shop Drawings, Submittal Log, Submittal Package.
  • items[].description
    stringrequired
  • items[].date
    string | nullrequired
  • items[].quantity
    integer | nullrequired
  • items[].notes
    string | nullrequired
  • items[].item_type
    stringrequired
    One of: freeform, document, drawing.
  • items[].ref_id
    integer | nullrequired
  • items[].ref
    null | objectrequired
  • items[].document_version_id
    integer | nullrequired
  • items[].drawing_revision_id
    integer | nullrequired
  • items[].source_upload_id
    integer | nullrequired
  • items[].source_revision_label
    string | nullrequired
  • created_by
    null | objectrequired
  • created_by.id
    integerrequired
  • created_by.login
    stringrequired
  • created_by.name
    stringrequired
  • created_at
    stringrequired
  • updated_at
    stringrequired
  • receipts
    object[]required
  • receipts[].user
    null | objectrequired
  • receipts[].received
    booleanrequired
  • receipts[].received_at
    string | nullrequired
  • receipts[].acknowledged
    booleanrequired

Errors

  • 401Authentication required
  • 403Permission denied
  • 404Record unavailable in the authorized project
  • 422Invalid request or business validation failure

Example request

Generated from the contractcurl
curl -X PATCH "https://app.os.construction/rest/v1.0/transmittals/1" \
  -H "Authorization: Bearer $OS_ACCESS_TOKEN" \
  -H "Idempotency-Key: $(uuidgen)" \
  -H 'Content-Type: application/json' \
  -d '{
  "transmittal": {}
}'
DELETE /rest/v1.0/transmittals/{id}

Move a transmittal to the recycle bin

Authorization and record visibility are checked by the existing REST handler; catalog presence does not grant access.

v1.0Implemented

Parameters

  • id
    integerpathrequired
  • project_id
    integerquery
  • Idempotency-Key
    stringheader
    Optional. A unique key (1-255 visible ASCII characters, e.g. a UUID) that makes a retry safe. The first request with a key runs; a 2xx response is stored for 24 hours and a retry with the same key, token and path gets that response again with `Idempotent-Replayed: true`. The same key with a different request returns 422; while the first request is still running, 409. A non-2xx response releases the key.

Response · 204

No response body.

Errors

  • 401Authentication required
  • 403Permission denied
  • 404Record unavailable in the authorized project
  • 422Invalid request or business validation failure

Example request

Generated from the contractcurl
curl -X DELETE "https://app.os.construction/rest/v1.0/transmittals/1" \
  -H "Authorization: Bearer $OS_ACCESS_TOKEN" \
  -H "Idempotency-Key: $(uuidgen)"
GET /rest/v1.0/transmittals/{id}/items/{item_id}/download

Download transmittal item

v1.0Implemented

Parameters

  • id
    integerpathrequired
  • item_id
    integerpathrequired

Response · 200 · object

No documented fields.

Errors

  • 401Missing, invalid or expired API token.
  • 403The token or user lacks the required scope or permission.
  • 404The record does not exist or belongs to another company.

Example request

Generated from the contractcurl
curl -X GET "https://app.os.construction/rest/v1.0/transmittals/1/items/1/download" \
  -H "Authorization: Bearer $OS_ACCESS_TOKEN"
PATCH /rest/v1.0/transmittals/{id}/receipts

Update a current recipient receipt

Requires a current recipient. The authenticated user may update their own receipt; project transmittals administrators may update other recipient receipts. Authorization and record visibility are checked by the existing REST handler; catalog presence does not grant access.

v1.0Implemented

Parameters

  • id
    integerpathrequired
  • project_id
    integerquery
  • Idempotency-Key
    stringheader
    Optional. A unique key (1-255 visible ASCII characters, e.g. a UUID) that makes a retry safe. The first request with a key runs; a 2xx response is stored for 24 hours and a retry with the same key, token and path gets that response again with `Idempotent-Replayed: true`. The same key with a different request returns 422; while the first request is still running, 409. A non-2xx response releases the key.

Request body

  • user_id
    integerrequired
  • received
    boolean
  • acknowledged
    boolean

Response · 200 · object

  • id
    integerrequired
  • number
    stringrequired
  • subject
    string | nullrequired
  • date
    string | nullrequired
  • to
    object[]required
  • to[].id
    integerrequired
  • to[].login
    stringrequired
  • to[].name
    stringrequired
  • cc
    object[]required
  • cc[].id
    integerrequired
  • cc[].login
    stringrequired
  • cc[].name
    stringrequired
  • from
    null | objectrequired
  • from.id
    integerrequired
  • from.login
    stringrequired
  • from.name
    stringrequired
  • sent_via
    anyrequired
    One of: attached, under_separate_cover, null.
  • private
    booleanrequired
  • submitted_for
    anyrequired
    One of: approval, your_use, as_requested, review_and_comment, further_processing, null.
  • actions
    object[]required
  • actions[].action
    stringrequired
    One of: out_for_signature, approved_as_submitted, approved_as_noted, submit, resubmitted, returned, returned_for_corrections, resubmit, due_by, received, received_as_noted, sent_date.
  • actions[].date
    string | nullrequired
  • remarks
    string | nullrequired
  • status
    anyrequired
    One of: sent, delivered.
  • delivered_date
    string | nullrequired
  • email_recorded_at
    string | nullrequired
  • items
    object[]required
  • items[].id
    integerrequired
  • items[].format
    stringrequired
    One of: Attic Stock, CDs, Commitment Contract, Communication, Document, Other, Plans, Potential Change Order, Prime Contract, Prints, Punch List Item, Purchase Order Contract, RFI, Samples, Shop Drawings, Submittal Log, Submittal Package.
  • items[].description
    stringrequired
  • items[].date
    string | nullrequired
  • items[].quantity
    integer | nullrequired
  • items[].notes
    string | nullrequired
  • items[].item_type
    stringrequired
    One of: freeform, document, drawing.
  • items[].ref_id
    integer | nullrequired
  • items[].ref
    null | objectrequired
  • items[].document_version_id
    integer | nullrequired
  • items[].drawing_revision_id
    integer | nullrequired
  • items[].source_upload_id
    integer | nullrequired
  • items[].source_revision_label
    string | nullrequired
  • created_by
    null | objectrequired
  • created_by.id
    integerrequired
  • created_by.login
    stringrequired
  • created_by.name
    stringrequired
  • created_at
    stringrequired
  • updated_at
    stringrequired
  • receipts
    object[]required
  • receipts[].user
    null | objectrequired
  • receipts[].received
    booleanrequired
  • receipts[].received_at
    string | nullrequired
  • receipts[].acknowledged
    booleanrequired

Errors

  • 401Authentication required
  • 403Permission denied
  • 404Record unavailable in the authorized project
  • 422Invalid request or business validation failure

Example request

Generated from the contractcurl
curl -X PATCH "https://app.os.construction/rest/v1.0/transmittals/1/receipts" \
  -H "Authorization: Bearer $OS_ACCESS_TOKEN" \
  -H "Idempotency-Key: $(uuidgen)" \
  -H 'Content-Type: application/json' \
  -d '{
  "user_id": 1
}'
POST /rest/v1.0/transmittals/{id}/restore

Restore a recycled transmittal

Requires the project transmittals delete permission. Authorization and record visibility are checked by the existing REST handler; catalog presence does not grant access.

v1.0Implemented

Parameters

  • id
    integerpathrequired
  • project_id
    integerquery
  • Idempotency-Key
    stringheader
    Optional. A unique key (1-255 visible ASCII characters, e.g. a UUID) that makes a retry safe. The first request with a key runs; a 2xx response is stored for 24 hours and a retry with the same key, token and path gets that response again with `Idempotent-Replayed: true`. The same key with a different request returns 422; while the first request is still running, 409. A non-2xx response releases the key.

Response · 200 · object

  • id
    integerrequired
  • number
    stringrequired
  • subject
    string | nullrequired
  • date
    string | nullrequired
  • to
    object[]required
  • to[].id
    integerrequired
  • to[].login
    stringrequired
  • to[].name
    stringrequired
  • cc
    object[]required
  • cc[].id
    integerrequired
  • cc[].login
    stringrequired
  • cc[].name
    stringrequired
  • from
    null | objectrequired
  • from.id
    integerrequired
  • from.login
    stringrequired
  • from.name
    stringrequired
  • sent_via
    anyrequired
    One of: attached, under_separate_cover, null.
  • private
    booleanrequired
  • submitted_for
    anyrequired
    One of: approval, your_use, as_requested, review_and_comment, further_processing, null.
  • actions
    object[]required
  • actions[].action
    stringrequired
    One of: out_for_signature, approved_as_submitted, approved_as_noted, submit, resubmitted, returned, returned_for_corrections, resubmit, due_by, received, received_as_noted, sent_date.
  • actions[].date
    string | nullrequired
  • remarks
    string | nullrequired
  • status
    anyrequired
    One of: sent, delivered.
  • delivered_date
    string | nullrequired
  • email_recorded_at
    string | nullrequired
  • items
    object[]required
  • items[].id
    integerrequired
  • items[].format
    stringrequired
    One of: Attic Stock, CDs, Commitment Contract, Communication, Document, Other, Plans, Potential Change Order, Prime Contract, Prints, Punch List Item, Purchase Order Contract, RFI, Samples, Shop Drawings, Submittal Log, Submittal Package.
  • items[].description
    stringrequired
  • items[].date
    string | nullrequired
  • items[].quantity
    integer | nullrequired
  • items[].notes
    string | nullrequired
  • items[].item_type
    stringrequired
    One of: freeform, document, drawing.
  • items[].ref_id
    integer | nullrequired
  • items[].ref
    null | objectrequired
  • items[].document_version_id
    integer | nullrequired
  • items[].drawing_revision_id
    integer | nullrequired
  • items[].source_upload_id
    integer | nullrequired
  • items[].source_revision_label
    string | nullrequired
  • created_by
    null | objectrequired
  • created_by.id
    integerrequired
  • created_by.login
    stringrequired
  • created_by.name
    stringrequired
  • created_at
    stringrequired
  • updated_at
    stringrequired
  • receipts
    object[]required
  • receipts[].user
    null | objectrequired
  • receipts[].received
    booleanrequired
  • receipts[].received_at
    string | nullrequired
  • receipts[].acknowledged
    booleanrequired

Errors

  • 401Authentication required
  • 403Permission denied
  • 404Record unavailable in the authorized project
  • 422Invalid request or business validation failure

Example request

Generated from the contractcurl
curl -X POST "https://app.os.construction/rest/v1.0/transmittals/1/restore" \
  -H "Authorization: Bearer $OS_ACCESS_TOKEN" \
  -H "Idempotency-Key: $(uuidgen)"
PATCH /rest/v1.0/transmittals/{id}/restore

Restore a recycled transmittal

Requires the project transmittals delete permission. Authorization and record visibility are checked by the existing REST handler; catalog presence does not grant access.

v1.0Implemented

Parameters

  • id
    integerpathrequired
  • project_id
    integerquery
  • Idempotency-Key
    stringheader
    Optional. A unique key (1-255 visible ASCII characters, e.g. a UUID) that makes a retry safe. The first request with a key runs; a 2xx response is stored for 24 hours and a retry with the same key, token and path gets that response again with `Idempotent-Replayed: true`. The same key with a different request returns 422; while the first request is still running, 409. A non-2xx response releases the key.

Response · 200 · object

  • id
    integerrequired
  • number
    stringrequired
  • subject
    string | nullrequired
  • date
    string | nullrequired
  • to
    object[]required
  • to[].id
    integerrequired
  • to[].login
    stringrequired
  • to[].name
    stringrequired
  • cc
    object[]required
  • cc[].id
    integerrequired
  • cc[].login
    stringrequired
  • cc[].name
    stringrequired
  • from
    null | objectrequired
  • from.id
    integerrequired
  • from.login
    stringrequired
  • from.name
    stringrequired
  • sent_via
    anyrequired
    One of: attached, under_separate_cover, null.
  • private
    booleanrequired
  • submitted_for
    anyrequired
    One of: approval, your_use, as_requested, review_and_comment, further_processing, null.
  • actions
    object[]required
  • actions[].action
    stringrequired
    One of: out_for_signature, approved_as_submitted, approved_as_noted, submit, resubmitted, returned, returned_for_corrections, resubmit, due_by, received, received_as_noted, sent_date.
  • actions[].date
    string | nullrequired
  • remarks
    string | nullrequired
  • status
    anyrequired
    One of: sent, delivered.
  • delivered_date
    string | nullrequired
  • email_recorded_at
    string | nullrequired
  • items
    object[]required
  • items[].id
    integerrequired
  • items[].format
    stringrequired
    One of: Attic Stock, CDs, Commitment Contract, Communication, Document, Other, Plans, Potential Change Order, Prime Contract, Prints, Punch List Item, Purchase Order Contract, RFI, Samples, Shop Drawings, Submittal Log, Submittal Package.
  • items[].description
    stringrequired
  • items[].date
    string | nullrequired
  • items[].quantity
    integer | nullrequired
  • items[].notes
    string | nullrequired
  • items[].item_type
    stringrequired
    One of: freeform, document, drawing.
  • items[].ref_id
    integer | nullrequired
  • items[].ref
    null | objectrequired
  • items[].document_version_id
    integer | nullrequired
  • items[].drawing_revision_id
    integer | nullrequired
  • items[].source_upload_id
    integer | nullrequired
  • items[].source_revision_label
    string | nullrequired
  • created_by
    null | objectrequired
  • created_by.id
    integerrequired
  • created_by.login
    stringrequired
  • created_by.name
    stringrequired
  • created_at
    stringrequired
  • updated_at
    stringrequired
  • receipts
    object[]required
  • receipts[].user
    null | objectrequired
  • receipts[].received
    booleanrequired
  • receipts[].received_at
    string | nullrequired
  • receipts[].acknowledged
    booleanrequired

Errors

  • 401Authentication required
  • 403Permission denied
  • 404Record unavailable in the authorized project
  • 422Invalid request or business validation failure

Example request

Generated from the contractcurl
curl -X PATCH "https://app.os.construction/rest/v1.0/transmittals/1/restore" \
  -H "Authorization: Bearer $OS_ACCESS_TOKEN" \
  -H "Idempotency-Key: $(uuidgen)"
POST /rest/v1.0/transmittals/create_from

Create a transmittal from documents or drawings

Creates a transmittal. deliver=true queues recipient email notifications and requires a UUID submission_key plus at least one recipient. Referenced documents/drawings require their corresponding source permissions. Select at least one document or drawing. Version selection arrays must match the corresponding IDs in length. Authorization and record visibility are checked by the existing REST handler; catalog presence does not grant access.

v1.0Implemented

Parameters

  • project_id
    integerqueryrequired
  • Idempotency-Key
    stringheader
    Optional. A unique key (1-255 visible ASCII characters, e.g. a UUID) that makes a retry safe. The first request with a key runs; a 2xx response is stored for 24 hours and a retry with the same key, token and path gets that response again with `Idempotent-Replayed: true`. The same key with a different request returns 422; while the first request is still running, 409. A non-2xx response releases the key.

Request body

  • transmittal
    objectrequired
  • transmittal.document_ids
    anyrequired

Response · 201 · object

  • id
    integerrequired
  • number
    stringrequired
  • subject
    string | nullrequired
  • date
    string | nullrequired
  • to
    object[]required
  • to[].id
    integerrequired
  • to[].login
    stringrequired
  • to[].name
    stringrequired
  • cc
    object[]required
  • cc[].id
    integerrequired
  • cc[].login
    stringrequired
  • cc[].name
    stringrequired
  • from
    null | objectrequired
  • from.id
    integerrequired
  • from.login
    stringrequired
  • from.name
    stringrequired
  • sent_via
    anyrequired
    One of: attached, under_separate_cover, null.
  • private
    booleanrequired
  • submitted_for
    anyrequired
    One of: approval, your_use, as_requested, review_and_comment, further_processing, null.
  • actions
    object[]required
  • actions[].action
    stringrequired
    One of: out_for_signature, approved_as_submitted, approved_as_noted, submit, resubmitted, returned, returned_for_corrections, resubmit, due_by, received, received_as_noted, sent_date.
  • actions[].date
    string | nullrequired
  • remarks
    string | nullrequired
  • status
    anyrequired
    One of: sent, delivered.
  • delivered_date
    string | nullrequired
  • email_recorded_at
    string | nullrequired
  • items
    object[]required
  • items[].id
    integerrequired
  • items[].format
    stringrequired
    One of: Attic Stock, CDs, Commitment Contract, Communication, Document, Other, Plans, Potential Change Order, Prime Contract, Prints, Punch List Item, Purchase Order Contract, RFI, Samples, Shop Drawings, Submittal Log, Submittal Package.
  • items[].description
    stringrequired
  • items[].date
    string | nullrequired
  • items[].quantity
    integer | nullrequired
  • items[].notes
    string | nullrequired
  • items[].item_type
    stringrequired
    One of: freeform, document, drawing.
  • items[].ref_id
    integer | nullrequired
  • items[].ref
    null | objectrequired
  • items[].document_version_id
    integer | nullrequired
  • items[].drawing_revision_id
    integer | nullrequired
  • items[].source_upload_id
    integer | nullrequired
  • items[].source_revision_label
    string | nullrequired
  • created_by
    null | objectrequired
  • created_by.id
    integerrequired
  • created_by.login
    stringrequired
  • created_by.name
    stringrequired
  • created_at
    stringrequired
  • updated_at
    stringrequired
  • receipts
    object[]required
  • receipts[].user
    null | objectrequired
  • receipts[].received
    booleanrequired
  • receipts[].received_at
    string | nullrequired
  • receipts[].acknowledged
    booleanrequired

Errors

  • 401Authentication required
  • 403Permission denied
  • 404Record unavailable in the authorized project
  • 422Invalid request or business validation failure

Example request

Generated from the contractcurl
curl -X POST "https://app.os.construction/rest/v1.0/transmittals/create_from" \
  -H "Authorization: Bearer $OS_ACCESS_TOKEN" \
  -H "Idempotency-Key: $(uuidgen)" \
  -H 'Content-Type: application/json' \
  -d '{
  "transmittal": {
    "document_ids": null
  }
}'
GET /rest/v1.0/transmittals/recycle_bin

List recycled project transmittals

Requires the project transmittals delete permission even though this operation is read only. Authorization and record visibility are checked by the existing REST handler; catalog presence does not grant access.

v1.0Implemented

Parameters

  • project_id
    integerqueryrequired
  • page
    integerquery
  • per_page
    integerquery

Response · 200 · object[]

  • id
    integerrequired
  • number
    stringrequired
  • subject
    string | nullrequired
  • date
    string | nullrequired
  • to
    object[]required
  • to[].id
    integerrequired
  • to[].login
    stringrequired
  • to[].name
    stringrequired
  • cc
    object[]required
  • cc[].id
    integerrequired
  • cc[].login
    stringrequired
  • cc[].name
    stringrequired
  • from
    null | objectrequired
  • from.id
    integerrequired
  • from.login
    stringrequired
  • from.name
    stringrequired
  • sent_via
    anyrequired
    One of: attached, under_separate_cover, null.
  • private
    booleanrequired
  • submitted_for
    anyrequired
    One of: approval, your_use, as_requested, review_and_comment, further_processing, null.
  • actions
    object[]required
  • actions[].action
    stringrequired
    One of: out_for_signature, approved_as_submitted, approved_as_noted, submit, resubmitted, returned, returned_for_corrections, resubmit, due_by, received, received_as_noted, sent_date.
  • actions[].date
    string | nullrequired
  • remarks
    string | nullrequired
  • status
    anyrequired
    One of: sent, delivered.
  • delivered_date
    string | nullrequired
  • email_recorded_at
    string | nullrequired
  • items
    object[]required
  • items[].id
    integerrequired
  • items[].format
    stringrequired
    One of: Attic Stock, CDs, Commitment Contract, Communication, Document, Other, Plans, Potential Change Order, Prime Contract, Prints, Punch List Item, Purchase Order Contract, RFI, Samples, Shop Drawings, Submittal Log, Submittal Package.
  • items[].description
    stringrequired
  • items[].date
    string | nullrequired
  • items[].quantity
    integer | nullrequired
  • items[].notes
    string | nullrequired
  • items[].item_type
    stringrequired
    One of: freeform, document, drawing.
  • items[].ref_id
    integer | nullrequired
  • items[].ref
    null | objectrequired
  • items[].document_version_id
    integer | nullrequired
  • items[].drawing_revision_id
    integer | nullrequired
  • items[].source_upload_id
    integer | nullrequired
  • items[].source_revision_label
    string | nullrequired
  • created_by
    null | objectrequired
  • created_by.id
    integerrequired
  • created_by.login
    stringrequired
  • created_by.name
    stringrequired
  • created_at
    stringrequired
  • updated_at
    stringrequired
  • receipts
    object[]required
  • receipts[].user
    null | objectrequired
  • receipts[].received
    booleanrequired
  • receipts[].received_at
    string | nullrequired
  • receipts[].acknowledged
    booleanrequired

Errors

  • 401Authentication required
  • 403Permission denied
  • 404Record unavailable in the authorized project
  • 422Invalid request or business validation failure

Example request

Generated from the contractcurl
curl -X GET "https://app.os.construction/rest/v1.0/transmittals/recycle_bin" \
  -H "Authorization: Bearer $OS_ACCESS_TOKEN"

Ask the OS

Reading this page

Ask anything about this page. Answers use what you're reading as context.

Suggested

    AI · may be imperfect · sample data where shown

    Open file