Skip to content
Navigation

List fundraising artifacts

GET
https://api.sureshake.com/v2/entities/{entityId}/vault/fundraising/artifacts

Path parameters

  • entityId
    string
    required
    format: uuid

Returns

200

Default Response

JSON
  • data
    array of
    object
    required
    • id
      string
      required
      format: uuid
    • entityId
      string
      required
      format: uuid
    • collectionId
      string
      or null
      required
      format: uuid
    • artifactType
      pitch_deck
      or
      investment_memo
      or
      supporting_file
      required
    • filename
      string
      required
    • mimeType
      string
      required
    • byteSize
      number
      or null
      required
    • sha256
      string
      or null
      required
    • storageKey
      string
      or null
      required
    • uploadStatus
      upload_session_created
      or
      uploaded
      or
      finalized
      or
      failed
      required
    • malwareScanStatus
      pending
      or
      passed
      or
      failed
      required
    • malwareScanError
      string
      or null
      required
    • version
      number
      required
    • tokenRequired
      boolean
      required
    • tokenNetwork
      base-mainnet
      required
    • tokenGrantStatus
      not_requested
      or
      pending
      or
      granted
      or
      revoked
      or
      failed
      required
    • createdBy
      string
      required
    • createdAt
      string
      required
      format: date-time
    • updatedAt
      string
      required
      format: date-time
    • uploadUrl
      optional
      string
      or null
    • uploadMethod
      optional
      PUT
    • uploadHeaders
      optional
      map of
      string
    • uploadExpiresAt
      optional
      string
      format: date-time
  • meta
    object
    required
    • total
      number
      required

      Total number of items available

    • limit
      number
      required

      Number of items per page

    • offset
      number
      required

      Number of items skipped

    • hasMore
      boolean
      required

      Whether more items are available

    • page
      optional
      number

      Current page number

    • totalPages
      optional
      number

      Total number of pages

400

Default Response
JSON
  • error
    object
    required
    • code
      string
      required

      Machine-readable error code (e.g., NOT_FOUND)

    • message
      string
      required

      Human-readable error message

    • details
      optional
      unknown

      Optional structured error details

    • traceId
      optional
      string

      Unique ID for log correlation

401

Default Response
JSON
  • error
    object
    required
    • code
      string
      required

      Machine-readable error code (e.g., NOT_FOUND)

    • message
      string
      required

      Human-readable error message

    • details
      optional
      unknown

      Optional structured error details

    • traceId
      optional
      string

      Unique ID for log correlation

403

Default Response
JSON
  • error
    object
    required
    • code
      string
      required

      Machine-readable error code (e.g., NOT_FOUND)

    • message
      string
      required

      Human-readable error message

    • details
      optional
      unknown

      Optional structured error details

    • traceId
      optional
      string

      Unique ID for log correlation

404

Default Response
JSON
  • error
    object
    required
    • code
      string
      required

      Machine-readable error code (e.g., NOT_FOUND)

    • message
      string
      required

      Human-readable error message

    • details
      optional
      unknown

      Optional structured error details

    • traceId
      optional
      string

      Unique ID for log correlation

409

Default Response
JSON
  • error
    object
    required
    • code
      string
      required

      Machine-readable error code (e.g., NOT_FOUND)

    • message
      string
      required

      Human-readable error message

    • details
      optional
      unknown

      Optional structured error details

    • traceId
      optional
      string

      Unique ID for log correlation

500

Default Response
JSON
  • error
    object
    required
    • code
      string
      required

      Machine-readable error code (e.g., NOT_FOUND)

    • message
      string
      required

      Human-readable error message

    • details
      optional
      unknown

      Optional structured error details

    • traceId
      optional
      string

      Unique ID for log correlation

503

Default Response
JSON
  • error
    object
    required
    • code
      string
      required

      Machine-readable error code (e.g., NOT_FOUND)

    • message
      string
      required

      Human-readable error message

    • details
      optional
      unknown

      Optional structured error details

    • traceId
      optional
      string

      Unique ID for log correlation

Type to search…

↑↓ navigate↵ selectEsc close