List entity

GET

https://api.sureshake.com/v2/entities

Query parameters

scope
optional
accessible
or
published
default: "accessible"

limit
optional
number
maximum: 100 · minimum: 1 · default: 20
offset
optional
number
minimum: 0 · default: 0
entityType
optional
fund
or
company
or
portfolio
or
asset
or
investor
or
educational_institution
+5 more
excludeEntityTypes
optional
array of
string
companySizeCategory
optional
string
verified
optional
boolean
parentId
optional
string
format: uuid
ownerId
optional
string
search
optional
string
maxLength: 100 · minLength: 1
sortBy
optional
name
or
createdAt
or
updatedAt
default: "createdAt"
sortOrder
optional
asc
or
desc
default: "desc"
include
optional
object
default: {}

Returns

200

Default Response

JSON

data
array of
object
required
- id
  string
  required
  format: uuid
- name
  string
  required
- slug
  string
  required
- description
  string
  or null
  required
- parentId
  string
  or null
  required
  format: uuid
- ownerId
  string
  required
- collectionId
  string
  or null
  required
  format: uuid
- entityType
  string
  or null
  required
- createdAt
  string
  required
  format: date-time
- updatedAt
  string
  required
  format: date-time
- overview
  optional
  string
  or null
- location
  optional
  string
  or null
- domain
  optional
  string
  or null
- twitterUrl
  optional
  string
  or null
- linkedinUrl
  optional
  string
  or null
- logoUrl
  optional
  string
  or null
- bannerUrl
  optional
  string
  or null
- metadata
  optional
  map of
  unknown
  or null
- verified
  optional
  boolean
  or null
- placeholderEntity
  optional
  boolean
  or null
- dataResidency
  optional
  string
  or null
- autoCreated
  optional
  boolean
  or null
- claimedBy
  optional
  string
  or null
- claimedAt
  optional
  string
  or null
  format: date-time
- createdBy
  optional
  string
  or null
- administrationAccess
  optional
  owner
  or
  admin
  or null
- resourceType
  optional
  entity
- parent
  optional
  object
  or null
  id
  string
  required
  format: uuid
  name
  string
  required
  slug
  string
  required
  description
  string
  or null
  required
  parentId
  string
  or null
  required
  format: uuid
  ownerId
  string
  required
  collectionId
  string
  or null
  required
  format: uuid
  entityType
  string
  or null
  required
  createdAt
  string
  required
  format: date-time
  updatedAt
  string
  required
  format: date-time
  overview
  optional
  string
  or null
  location
  optional
  string
  or null
  domain
  optional
  string
  or null
  twitterUrl
  optional
  string
  or null
  linkedinUrl
  optional
  string
  or null
  logoUrl
  optional
  string
  or null
  bannerUrl
  optional
  string
  or null
  metadata
  optional
  map of
  unknown
  or null
  verified
  optional
  boolean
  or null
  placeholderEntity
  optional
  boolean
  or null
  dataResidency
  optional
  string
  or null
  autoCreated
  optional
  boolean
  or null
  claimedBy
  optional
  string
  or null
  claimedAt
  optional
  string
  or null
  format: date-time
  createdBy
  optional
  string
  or null
- children
  optional
  array of
  object
  id
  string
  required
  format: uuid
  name
  string
  required
  slug
  string
  required
  description
  string
  or null
  required
  parentId
  string
  or null
  required
  format: uuid
  ownerId
  string
  required
  collectionId
  string
  or null
  required
  format: uuid
  entityType
  string
  or null
  required
  createdAt
  string
  required
  format: date-time
  updatedAt
  string
  required
  format: date-time
  overview
  optional
  string
  or null
  location
  optional
  string
  or null
  domain
  optional
  string
  or null
  twitterUrl
  optional
  string
  or null
  linkedinUrl
  optional
  string
  or null
  logoUrl
  optional
  string
  or null
  bannerUrl
  optional
  string
  or null
  metadata
  optional
  map of
  unknown
  or null
  verified
  optional
  boolean
  or null
  placeholderEntity
  optional
  boolean
  or null
  dataResidency
  optional
  string
  or null
  autoCreated
  optional
  boolean
  or null
  claimedBy
  optional
  string
  or null
  claimedAt
  optional
  string
  or null
  format: date-time
  createdBy
  optional
  string
  or null
- collection
  optional
  unknown
  or null
- followers
  optional
  array of
  unknown
- roles
  optional
  array of
  unknown
- documents
  optional
  array of
  unknown
- personnel
  optional
  array of
  object
  id
  string
  required
  format: uuid
  name
  string
  required
  title
  string
  required
  role
  string
  required
  status
  string
  required
  isKeyPerson
  boolean
  required
  department
  optional
  string
  or null
  email
  optional
  string
  or null
  phone
  optional
  string
  or null
- teamMembers
  optional
  array of
  object
  id
  string
  required
  format: uuid
  userId
  string
  required
  name
  string
  required
  email
  optional
  string
  or null
  title
  optional
  string
  or null
  role
  optional
  string
  or null
  portfolioRole
  optional
  string
  or null
  avatar
  optional
  string
  or null
- tagline
  optional
  string
  or null
- companySizeCategory
  optional
  string
  or null
- followersCount
  optional
  number
- isFollowing
  optional
  boolean
- creditReferencesCount
  optional
  number
- customerReferencesCount
  optional
  number
- claimStatus
  optional
  not_claimable
  or
  claimed
  or
  claim_pending
  or
  unclaimed
- canClaim
  optional
  boolean
- connectionCount
  optional
  number
- mutualConnections
  optional
  number
- isConnected
  optional
  boolean
}
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
}

422

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
}

{ "data": [ { "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08", "name": "string", "slug": "string", "description": "string", "overview": "string", "location": "string", "domain": "string", "twitterUrl": "string", "linkedinUrl": "string", "parentId": "70850378-7d3c-4f45-91b7-942d4dfbbd43", "ownerId": "string", "collectionId": "0ffe69e2-b7af-4b1e-835c-867376165f50", "entityType": "string", "logoUrl": "string", "bannerUrl": "string", "metadata": { "property1": null, "property2": null }, "verified": true, "placeholderEntity": true, "dataResidency": "string", "autoCreated": true, "claimedBy": "string", "claimedAt": "2019-08-24T14:15:22Z", "createdBy": "string", "createdAt": "2019-08-24T14:15:22Z", "updatedAt": "2019-08-24T14:15:22Z", "administrationAccess": "owner", "resourceType": "entity", "parent": { "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08", "name": "string", "slug": "string", "description": "string", "overview": "string", "location": "string", "domain": "string", "twitterUrl": "string", "linkedinUrl": "string", "parentId": "70850378-7d3c-4f45-91b7-942d4dfbbd43", "ownerId": "string", "collectionId": "0ffe69e2-b7af-4b1e-835c-867376165f50", "entityType": "string", "logoUrl": "string", "bannerUrl": "string", "metadata": { "property1": null, "property2": null }, "verified": true, "placeholderEntity": true, "dataResidency": "string", "autoCreated": true, "claimedBy": "string", "claimedAt": "2019-08-24T14:15:22Z", "createdBy": "string", "createdAt": "2019-08-24T14:15:22Z", "updatedAt": "2019-08-24T14:15:22Z" }, "children": [ { "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08", "name": "string", "slug": "string", "description": "string", "overview": "string", "location": "string", "domain": "string", "twitterUrl": "string", "linkedinUrl": "string", "parentId": "70850378-7d3c-4f45-91b7-942d4dfbbd43", "ownerId": "string", "collectionId": "0ffe69e2-b7af-4b1e-835c-867376165f50", "entityType": "string", "logoUrl": "string", "bannerUrl": "string", "metadata": { "property1": null, "property2": null }, "verified": true, "placeholderEntity": true, "dataResidency": "string", "autoCreated": true, "claimedBy": "string", "claimedAt": "2019-08-24T14:15:22Z", "createdBy": "string", "createdAt": "2019-08-24T14:15:22Z", "updatedAt": "2019-08-24T14:15:22Z" } ], "collection": null, "followers": [], "roles": [], "documents": [], "personnel": [ { "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08", "name": "string", "title": "string", "role": "string", "department": "string", "email": "string", "phone": "string", "status": "string", "isKeyPerson": true } ], "teamMembers": [ { "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08", "userId": "string", "name": "string", "email": "string", "title": "string", "role": "string", "portfolioRole": "string", "avatar": "string" } ], "tagline": "string", "companySizeCategory": "string", "followersCount": 0, "isFollowing": true, "creditReferencesCount": 0, "customerReferencesCount": 0, "claimStatus": "not_claimable", "canClaim": true, "connectionCount": 0, "mutualConnections": 0, "isConnected": true } ], "meta": { "total": 0, "limit": 0, "offset": 0, "hasMore": true, "page": 0, "totalPages": 0 } }