Get private collection

GET

https://api.sureshake.com/v2/directory/collections/{collectionId}

Path parameters

collectionId
string
required
format: uuid

Query parameters

actingPrincipal
optional
object
principalType
optional
user
or
entity
or
organization
principalId
optional
string
maxLength: 255 · minLength: 1
privateBrowsing
optional
boolean
default: false

Returns

200

Default Response

JSON

data
object
required
- id
  string
  required
  format: uuid
- name
  string
  required
- description
  string
  or null
  required
- entityId
  string
  or null
  required
  format: uuid
- content
  object
  required
  reports
  array of
  object
  required
  id
  string
  required
  format: uuid
  title
  string
  required
  description
  string
  or null
  required
  reportType
  string
  required
  status
  string
  required
  fiscalPeriodStart
  string
  or null
  required
  format: date-time
  fiscalPeriodEnd
  string
  or null
  required
  format: date-time
  data
  map of
  unknown
  or null
  required
  createdAt
  string
  required
  format: date-time
  updatedAt
  string
  required
  format: date-time
  creditInfoSheets
  array of
  object
  required
  id
  string
  required
  format: uuid
  title
  string
  required
  status
  string
  required
  data
  map of
  unknown
  required
  createdAt
  string
  required
  format: date-time
  updatedAt
  string
  required
  format: date-time
  loanPackages
  array of
  object
  required
  id
  string
  required
  format: uuid
  title
  string
  required
  description
  string
  or null
  required
  status
  string
  required
  data
  map of
  unknown
  required
  createdAt
  string
  required
  format: date-time
  updatedAt
  string
  required
  format: date-time
- artifacts
  array of
  object
  required
  id
  string
  required
  format: uuid
  artifactType
  string
  required
  filename
  string
  required
  mimeType
  string
  required
  byteSize
  integer
  or null
  required
  version
  integer
  required
  downloadUrl
  string
  required
  format: uri
  accessExpiresAt
  string
  required
  format: date-time
- tokenAuthorization
  object
  required
  walletAddress
  string
  required
  tokenId
  string
  required
  expiresAt
  string
  or null
  required
  format: date-time
- artifactAccessExpiresAt
  string
  or null
  required
  format: date-time
}
meta
optional
object
- timestamp
  string
  required
  format: date-time
}

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
}

429

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
}