List by entity

GET

https://api.sureshake.com/v2/entities/{entityId}/portfolios

Path parameters

entityId
string
required
format: uuid

Returns

200

Default Response

JSON

data
array of
object
required
- id
  string
  required
  format: uuid
- userId
  string
  or null
  required
- entityId
  string
  or null
  required
  format: uuid
- createdByUserId
  string
  required
- title
  string
  required
- slug
  string
  required
- summary
  string
  or null
  required
- description
  string
  or null
  required
- startDate
  string
  required
  format: date-time
- endDate
  string
  or null
  required
  format: date-time
- ongoing
  boolean
  required
- portfolioType
  case_study
  or
  client_work
  or
  internal_project
  or
  product_launch
  or
  open_source
  or
  research
  +2 more
  required
- category
  string
  or null
  required
- visibility
  public
  or
  private
  or
  team_only
  or
  unlisted
  required
- featured
  boolean
  required
- outcomes
  object
  or null
  required
  metrics
  optional
  array of
  object
  label
  string
  required
  value
  required
  Any of the following:
  string
  number
  unit
  optional
  string
  description
  optional
  string
  achievements
  optional
  array of
  string
  impact
  optional
  string
- externalUrl
  string
  or null
  required
- repositoryUrl
  string
  or null
  required
- coverImageKey
  string
  or null
  required
- displayOrder
  number
  required
- createdAt
  string
  required
  format: date-time
- updatedAt
  string
  required
  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
}

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
}

{ "data": [ { "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08", "userId": "string", "entityId": "156e622c-6cdf-4c27-9bc9-2f2db69919f5", "createdByUserId": "string", "title": "string", "slug": "string", "summary": "string", "description": "string", "startDate": "2019-08-24T14:15:22Z", "endDate": "2019-08-24T14:15:22Z", "ongoing": true, "portfolioType": "case_study", "category": "string", "visibility": "public", "featured": true, "outcomes": { "metrics": [ { "label": "string", "value": "string", "unit": "string", "description": "string" } ], "achievements": [ "string" ], "impact": "string" }, "externalUrl": "string", "repositoryUrl": "string", "coverImageKey": "string", "displayOrder": 0, "createdAt": "2019-08-24T14:15:22Z", "updatedAt": "2019-08-24T14:15:22Z" } ], "meta": { "total": 0, "limit": 0, "offset": 0, "hasMore": true, "page": 0, "totalPages": 0 } }